Documentation
¶
Overview ¶
Package mydms mydms-API
The API of the mydms-application.
Terms Of Service:
Schemes: https Host: mydms.binggl.net BasePath: /api/v1 Version: 3.0.0 License: Apache 2.0 https://opensource.org/licenses/Apache-2.0 Consumes: - application/json Produces: - application/json
swagger:meta
Index ¶
- func EndpointLoggingMiddleware(logger logging.Logger, endpointName string) endpoint.Middleware
- func MakeHTTPHandler(e Endpoints, logger logging.Logger, opts HTTPHandlerOptions) http.Handler
- type AppConfig
- type Database
- type DocumentRequest
- type DocumentRequestSwagger
- type Endpoints
- type EntriesResult
- type FileStore
- type HTTPHandlerOptions
- type UploadConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EndpointLoggingMiddleware ¶
func EndpointLoggingMiddleware(logger logging.Logger, endpointName string) endpoint.Middleware
EndpointLoggingMiddleware returns an endpoint middleware that logs the duration of each invocation, and the resulting error, if any.
func MakeHTTPHandler ¶
MakeHTTPHandler mounts all service endpoints into an http.Handler.
Types ¶
type AppConfig ¶
type AppConfig struct {
config.BaseConfig
Database Database
Upload UploadConfig
Filestore FileStore
}
AppConfig holds the application configuration
type Database ¶
type Database struct {
ConnectionString string
}
Database defines the connection string
type DocumentRequest ¶
DocumentRequest is the request payload for the Document data model.
func (*DocumentRequest) Bind ¶
func (d *DocumentRequest) Bind(r *http.Request) error
Bind assigns the the provided data to a DocumentRequest
func (*DocumentRequest) String ¶
func (d *DocumentRequest) String() string
String returns a string representation of a DocumentRequest
type DocumentRequestSwagger ¶
DocumentRequestSwagger is used for swagger docu swagger:parameters SaveDocument
type Endpoints ¶
type Endpoints struct {
GetAppInfoEndpoint endpoint.Endpoint
GetDocumentByIDEndpoint endpoint.Endpoint
DeleteDocumentByIDEndpoint endpoint.Endpoint
SearchListEndpoint endpoint.Endpoint
SearchDocumentsEndpoint endpoint.Endpoint
SaveDocumentEndpoint endpoint.Endpoint
GetFileEndpoint endpoint.Endpoint
}
Endpoints collects all of the endpoints that compose a profile service. It's meant to be used as a helper struct, to collect all of the endpoints into a single parameter.
type EntriesResult ¶
type EntriesResult struct {
Lenght int `json:"length,omitempty"`
Entries []string `json:"result,omitempty"`
}
EntriesResult holds a list of strings swagger:model
type HTTPHandlerOptions ¶
type HTTPHandlerOptions struct {
BasePath string
ErrorPath string
JWTConfig config.Security
CookieConfig config.ApplicationCookies
CorsConfig config.CorsSettings
AssetConfig config.AssetSettings
}
HTTPHandlerOptions containts configuration settings relevant for the HTTP handler implementation
type UploadConfig ¶
type UploadConfig struct {
// EndpointURL defines the upload endpoint api URL
EndpointURL string
}
UploadConfig defines relevant values for the upload logic
Source Files
Directories