API-35: Swagger documentation #17

Merged
Paddy merged 9 commits from API-35 into master 2022-01-09 15:19:49 +00:00
3 changed files with 28 additions and 2 deletions
Showing only changes of commit b3abeaa264 - Show all commits

2
app.ts
View File

@ -37,7 +37,7 @@ app.use(
swaggerUi.serve, swaggerUi.serve,
swaggerUi.setup(undefined, { swaggerUi.setup(undefined, {
swaggerOptions: { swaggerOptions: {
url: '/public/swagger.json' url: '/swagger.json'
} }
}) })
); );

26
swagger.json Normal file
View File

@ -0,0 +1,26 @@
{
"components": {
"examples": {},
"headers": {},
"parameters": {},
"requestBodies": {},
"responses": {},
"schemas": {},
"securitySchemes": {}
},
"info": {
"title": "plutodev_express_api",
"version": "1.0.0",
"license": {
"name": "ISC"
},
"contact": {}
},
"openapi": "3.0.0",
"paths": {},
"servers": [
{
"url": "/"
}
]
}

View File

@ -2,7 +2,7 @@
"entryFile": "app.ts", "entryFile": "app.ts",
"noImplicitAdditionalProperties": "throw-on-extras", "noImplicitAdditionalProperties": "throw-on-extras",
"spec": { "spec": {
"outputDirectory": "public", "outputDirectory": ".",
"specVersion": 3 "specVersion": 3
} }
} }