go/golang-saas-starter-kit
1
0
Fork 0
mirror of https://github.com/raseels-repos/golang-saas-starter-kit.git synced 2025-06-21 00:29:46 +02:00
Code Issues Releases Activity

completed API from signup to auth token with swagger UI.

Browse Source
This commit is contained in:
Lee Brown
2019-06-25 06:25:55 -08:00
parent 2fbda74a73
commit 8328cf525b
15 changed files with 443 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

105
example-project/cmd/web-api/docs/docs.go
View File

@ -1,6 +1,6 @@
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
// This file was generated by swaggo/swag at
// 2019-06-25 02:19:21.144417 -0800 AKDT m=+51.040366621
// 2019-06-25 06:15:54.005963 -0800 AKDT m=+73.603716546
package docs
@ -33,6 +33,11 @@ var doc = `{
"paths": {
"/accounts/{id}": {
"get": {
"security": [
{
"OAuth2Password": []
}
],
"description": "get string by ID",
"consumes": [
"application/json"
@ -44,10 +49,9 @@ var doc = `{
"account"
],
"summary": "Read returns the specified account from the system.",
"operationId": "get-string-by-int",
"parameters": [
{
"type": "integer",
"type": "string",
"description": "Account ID",
"name": "id",
"in": "path",
@ -92,6 +96,62 @@ var doc = `{
}
}
},
"/oauth/token": {
"post": {
"security": [
{
"BasicAuth": []
}
],
"description": "Token generates an oauth2 accessToken using Basic Auth with a user's email and password.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Token handles a request to authenticate a user.",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"$ref": "#/definitions/user.Token"
},
"headers": {
"Token": {
"type": "string",
"description": "qwerty"
}
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.Error"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.Error"
}
},
"404": {
"description": "Not Found",
"schema": {
"type": "object",
"$ref": "#/definitions/web.Error"
}
}
}
}
},
"/signup": {
"post": {
"description": "Signup creates a new account and user in the system.",
@ -150,6 +210,11 @@ var doc = `{
},
"/users/{id}": {
"get": {
"security": [
{
"OAuth2Password": []
}
],
"description": "get string by ID",
"consumes": [
"application/json"
@ -161,14 +226,20 @@ var doc = `{
"user"
],
"summary": "Read returns the specified user from the system.",
"operationId": "get-string-by-int",
"parameters": [
{
"type": "integer",
"type": "string",
"description": "User ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "Authentication header",
"name": "Authorization",
"in": "header",
"required": true
}
],
"responses": {
@ -360,6 +431,20 @@ var doc = `{
}
}
},
"user.Token": {
"type": "object",
"properties": {
"access_token": {
"type": "string"
},
"expiry": {
"type": "string"
},
"token_type": {
"type": "string"
}
}
},
"user.User": {
"type": "object",
"required": [
@ -412,10 +497,18 @@ var doc = `{
}
},
"securityDefinitions": {
"BasicAuth": {
"type": "basic"
},
"OAuth2Password": {
"type": "oauth2",
"flow": "password",
"tokenUrl": "/v1/oauth/token"
"tokenUrl": "/v1/oauth/token",
"scopes": {
"admin": " Grants read and write access to administrative information",
"read": " Grants read access",
"write": " Grants write access"
}
}
}
}`