monkeytypegame/monkeytype
1
1
Fork 0
mirror of https://github.com/monkeytypegame/monkeytype.git synced 2025-02-03 04:19:06 +08:00
Code Issues Projects Releases Packages Wiki Activity

added basic swagger spec

Browse source 
part of #2605
This commit is contained in:
Miodec 2022-02-28 19:53:07 +01:00
parent af94af3667
commit 2c05a1ccc1
1 changed files with 50 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
backend/swagger.json Normal file
View file

@ -0,0 +1,50 @@
{
"swagger": "2.0",
"info": {
"version": "1.0.0",
"title": "Monkeytype",
"termsOfService": "http://monkeytype.com/terms-of-service",
"contact": {
"name": "Developer",
"email": "jack@monkeytype.com"
}
},
"host": "api.monkeytype.com",
"basePath": "/",
"schemes": ["https"],
"consumes": ["application/json"],
"produces": ["application/json"],
"paths": {
"/users": {
"get": {
"description": "Returns user data",
"produces": ["application/json"],
"responses": {
"200": {
"description": "User data.",
"schema": {
"$ref": "#/definitions/Response"
}
}
}
}
}
},
"definitions": {
"Response": {
"type": "object",
"required": ["error", "message", "data"],
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}