README
¶
backend
Backend for kabelliste.
Init
You will need to setup some docker executable in you path for testing.
$ sudo apt-get install mariadb-server
$ sudo make init # install and start environment dependencies
$ make run
Auth
You will need to set the following attributes on https://stubidp.sustainsys.com/ to a valid (in database + active) email address:
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
Otherwise most routes are not accessbile.
Help
$ ./backend -help
Documentation
¶
Overview ¶
Package Server kabelliste API
This is the backend, which offers the cable database through a REST API.
Access is only granted with proper authentication tokens and roles of the calling client. The token is not to be set over OpenAPI, but on the very start of this website. (OpenAPIv2 does not support Cookie security settings) If you can read this text, you already got a valid token.
The official draft can be found in the wiki. This code is version controller at this repository. The `go doc` output can be viewed at pkg.go.dev.
Meta information about the current deployment you are using can be accessed at `/api/info`.
Feel free to open an issue if something doesn't work as expected.
Contact: Chris A. Fröschl <chris.froeschl@br.de> Schemes: http, https Consumes: - application/json Produces: - application/json - application/xml - application/zip - text/html Security: - token: Extensions: x-meta-value: value x-meta-array:
- value1
- value2
x-meta-array-obj:
- name: obj value: field
swagger:meta
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package config holds the global configuration of this application.
|
Package config holds the global configuration of this application. |
|
Package controller holds the "C" of the MVC pattern here.
|
Package controller holds the "C" of the MVC pattern here. |
|
See https://google.github.io/styleguide/jsoncstyleguide.xml?showone=data#data
|
See https://google.github.io/styleguide/jsoncstyleguide.xml?showone=data#data |
|
It is inspired by the regex table mentioned in https://benhoyt.com/writings/go-routing/#regex-table
|
It is inspired by the regex table mentioned in https://benhoyt.com/writings/go-routing/#regex-table |
|
service
|
|