api

package

v0.0.0-...-2a11bd6 Latest Latest Go to latest Published: Feb 13, 2021 License: MIT Imports: 19 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/johncoleman83/cerebrum

Links

Open Source Insights

Documentation ¶

Overview ¶

Package api contains all methodology for interacting with the persistence layer

API Docs for CEREBRUM v1

Consumes:
- application/json

Produces:
- application/json

Security:
- ApiKeyAuth: []

SecurityDefinitions:
ApiKeyAuth:
     type: apiKey
     name: Authorization
     in: header

Index ¶

func Start(cfg *config.Configuration) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Start ¶

func Start(cfg *config.Configuration) error

Start starts the API service

Types ¶

This section is empty.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
auth Package auth is a service for authenticating http requets	Package auth is a service for authenticating http requets
logging
transport Package transport contians HTTP service for authentication	Package transport contians HTTP service for authentication
password Package password contains the service that handles passwords	Package password contains the service that handles passwords
logging
transport
store Package store contains the components necessary for api services to interact with the database	Package store contains the components necessary for api services to interact with the database
user Package user contains the service for user interactions	Package user contains the service for user interactions
logging
transport Package transport contains the HTTP service for user interactions	Package transport contains the HTTP service for user interactions

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL