stefan.stamenovic
/
diligent-node-api
Tarkkaile 2
Äänestä 0
Fork 0
Koodi Ongelmat 0 Pull-pyynnöt 0 Julkaisut 0 Wiki Activity
Selaa lähdekoodia

Swagger is now stored in single js file

pull/61/head
dusan-lazarevic 3 vuotta sitten
vanhempi
c6e91eaf10 6b73449a2a
commit
48f67c0603
17 muutettua tiedostoa jossa 353 lisäystä ja 413 poistoa
Yhdistetty näkymä Näytä diff tilastot
  1. 0
    7
      src/documentation/basicInfo.js
  2. 0
    41
      src/documentation/components.js
  3. 0
    14
      src/documentation/index.js
  4. 0
    34
      src/documentation/routesDesc/index.js
  5. 0
    35
      src/documentation/routesDesc/token/loginUserDesc.js
  6. 0
    27
      src/documentation/routesDesc/token/logoutDesc.js
  7. 0
    24
      src/documentation/routesDesc/token/refreshTokenDesc.js
  8. 0
    48
      src/documentation/routesDesc/user/createUserDesc.js
  9. 0
    30
      src/documentation/routesDesc/user/deleteUserDesc.js
  10. 0
    38
      src/documentation/routesDesc/user/getUserDesc.js
  11. 0
    25
      src/documentation/routesDesc/user/getUsersDesc.js
  12. 0
    25
      src/documentation/routesDesc/user/updateUserContactsDesc.js
  13. 0
    48
      src/documentation/routesDesc/user/updateUserDesc.js
  14. 0
    8
      src/documentation/servers.js
  15. 0
    7
      src/documentation/tags.js
  16. 2
    2
      src/server.js
  17. 351
    0
      src/swagger.js

+ 0
- 7
src/documentation/basicInfo.js Näytä tiedosto

module.exports = {
openapi: "3.0.3",
info: {
title: "Trampa",
description: "Trampa api"
}
}

+ 0
- 41
src/documentation/components.js Näytä tiedosto

module.exports = {
components: {
schemas: {
id: {
type: "string",
description: "An id of a user"
},
User: {
type: "object",
properties: {
name: {
type: "string"
},
email: {
type: "string"
},
password: {
type: "string"
},
tokens: {
type: "array",
items: {
type: "string"
}
}
}
},
Token: {
type: "object",
properties: {
token: {
type: "string"
},
userId: {
type: "string"
}
}
}
}
}
}

+ 0
- 14
src/documentation/index.js Näytä tiedosto

const basicInfo = require('./basicInfo');
const servers = require('./servers');
const components = require('./components');
const tags = require('./tags');
const routesDesc = require('./routesDesc');
module.exports = {
...basicInfo,
...servers,
...components,
...tags,
...routesDesc
}

+ 0
- 34
src/documentation/routesDesc/index.js Näytä tiedosto

const getUser = require('./user/getUserDesc');
const getUsers = require('./user/getUsersDesc');
const createUser = require('./user/createUserDesc');
const updateUser = require('./user/updateUserDesc');
const updateUserContacts = require('./user/updateUserContactsDesc');
const deleteUserDesc = require('./user/deleteUserDesc');
const loginUserDesc = require('./token/loginUserDesc');
const logoutDesc = require('./token/logoutDesc');
const refreshTokenDesc = require('./token/refreshTokenDesc');
module.exports = {
paths: {
'/users': {
...getUsers,
...createUser
},
'/users/{id}': {
...getUser,
...updateUser,
...updateUserContacts,
...deleteUserDesc
},
'/auth/token': {
...loginUserDesc
},
'/auth/logout': {
...logoutDesc
},
'/auth/refresh': {
...refreshTokenDesc
}
}
}

+ 0
- 35
src/documentation/routesDesc/token/loginUserDesc.js Näytä tiedosto

module.exports = {
post: {
tags: ["Token"],
description: "Log in user",
parameters: [],
requestBody: {
content: {
"application/json": {
schema: {
type: "object",
properties: {
email: {
type: "string"
},
password: {
type: "string"
}
}
}
}
}
},
responses: {
201: {
description: "User logged in successfully!"
},
400: {
description: "Wrong credentials!"
},
500: {
description: "Internal server error"
}
}
}
}

+ 0
- 27
src/documentation/routesDesc/token/logoutDesc.js Näytä tiedosto

module.exports = {
post: {
tags: ["Token"],
description: "Log out user",
parameters: [],
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/Token"
}
}
}
},
responses: {
201: {
description: "User logged out successfully"
},
404: {
description: "No user has the token provided!"
},
500: {
description: "Internal server error"
}
}
}
}

+ 0
- 24
src/documentation/routesDesc/token/refreshTokenDesc.js Näytä tiedosto

module.exports = {
post: {
tags: ["Token"],
description: "Log out user",
parameters: [],
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/Token"
}
}
}
},
responses: {
201: {
description: "User refreshed successfully"
},
404: {
description: "Token not valid!"
}
}
}
}

+ 0
- 48
src/documentation/routesDesc/user/createUserDesc.js Näytä tiedosto

module.exports = {
post: {
tags: ["User"],
description: "Create user",
parameters: [],
requestBody: {
content: {
"application/json": {
schema: {
type: "object",
properties: {
name: {
type: "string"
},
email: {
type: "string"
},
password: {
type: "string"
}
}
}
}
}
},
responses: {
201: {
description: "User created successfully",
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/User"
},
},
},
},
400: {
description: "Object cant be empty",
},
401: {
description: "Invalid input parameters",
},
500: {
description: "Internal server error",
}
}
}
}

+ 0
- 30
src/documentation/routesDesc/user/deleteUserDesc.js Näytä tiedosto

module.exports = {
delete: {
tags: ["User"],
description: "Delete user",
parameters: [
{
name: "id",
in: "path",
schema: {
$ref: "#/components/schemas/id",
},
required: true,
},
],
responses: {
204: {
description: "User deleted successfully",
},
400: {
description: "You need to provide valid Id'",
},
404: {
description: "User not found",
},
500: {
description: "Internal server error",
},
},
},
};

+ 0
- 38
src/documentation/routesDesc/user/getUserDesc.js Näytä tiedosto

module.exports = {
get: {
tags: ["User"],
description: "Get user by id",
parameters: [
{
name: "id",
in: "path",
schema: {
$ref: "#/components/schemas/id",
},
required: true,
description: "A single user id",
}
],
responses: {
200: {
description: "Success",
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/User",
}
}
}
},
400: {
description: "Bad request"
},
404: {
description: "User with specified id does not exist"
},
500: {
description: "Internal server error"
}
}
}
}

+ 0
- 25
src/documentation/routesDesc/user/getUsersDesc.js Näytä tiedosto

module.exports = {
get: {
tags: ["User"],
description: "Get all users",
parameters: [],
responses: {
200: {
description: "Success",
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/User",
}
}
}
},
200: {
description: "Users returned successfully"
},
500: {
description: "Internal server error"
}
}
}
}

+ 0
- 25
src/documentation/routesDesc/user/updateUserContactsDesc.js Näytä tiedosto

module.exports = {
patch: {
tags: ["User"],
description: "Update user",
parameters: [
{
name: "id",
in: "path",
// schema: {
// $ref: "#/components/schemas/id", // data model of the param
// },
required: true,
description: "A single user id",
}
],
requestBody: {
content: {
}
},
responses: {
}
}
}

+ 0
- 48
src/documentation/routesDesc/user/updateUserDesc.js Näytä tiedosto

module.exports = {
put: {
tags: ["User"],
description: "Update user",
parameters: [
{
name: "id",
in: "path",
schema: {
$ref: "#/components/schemas/id", // data model of the param
},
required: true,
description: "A single user id",
}
],
requestBody: {
content: {
"application/json": {
schema: {
type: "object",
properties: {
name: {
type: "string"
},
email: {
type: "string"
},
password: {
type: "string"
}
}
}
}
}
},
responses: {
200: {
description: "User updated successfully",
},
400: {
description: "Invalid input parameters",
},
500: {
description: "Server error",
}
}
}
}

+ 0
- 8
src/documentation/servers.js Näytä tiedosto

module.exports = {
servers: [
{
url: "http://localhost:3000/",
description: "Local server",
},
],
}

+ 0
- 7
src/documentation/tags.js Näytä tiedosto

module.exports = {
tags: [
{
name: "User"
},
],
}

+ 2
- 2
src/server.js Näytä tiedosto

require('./database/mongoose') require('./database/mongoose')
const userRouter = require('./routes/user') const userRouter = require('./routes/user')
const tokenRouter = require('./routes/token') const tokenRouter = require('./routes/token')
const docs = require('./documentation');
const swaggerUI = require("swagger-ui-express")
const docs = require('./swagger.js');
const swaggerUI = require('swagger-ui-express')
const { errorLogger, errorResponder } = require('./middleware/errorHandling.js') const { errorLogger, errorResponder } = require('./middleware/errorHandling.js')
const requestLogging = require('./middleware/requestLogging.js') const requestLogging = require('./middleware/requestLogging.js')
const cors = require('cors') //Cross-origin resource sharing const cors = require('cors') //Cross-origin resource sharing

+ 351
- 0
src/swagger.js Näytä tiedosto

module.exports = {
servers: [
{
url: "http://localhost:3001/",
description: "Local server",
},
],
tags: [
{
name: "User"
},
],
openapi: "3.0.3",
info: {
title: "Trampa",
description: "Trampa api"
},
paths: {
'/users': {
get: {
tags: ["User"],
description: "Get all users",
parameters: [],
responses: {
200: {
description: "Success",
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/User",
}
}
}
},
200: {
description: "Users returned successfully"
},
500: {
description: "Internal server error"
}
}
},
post: {
tags: ["User"],
description: "Create user",
parameters: [],
requestBody: {
content: {
"application/json": {
schema: {
type: "object",
properties: {
name: {
type: "string"
},
email: {
type: "string"
},
password: {
type: "string"
}
}
}
}
}
},
responses: {
201: {
description: "User created successfully",
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/User"
},
},
},
},
400: {
description: "Object cant be empty",
},
401: {
description: "Invalid input parameters",
},
500: {
description: "Internal server error",
}
}
}
},
'/users/{id}': {
get: {
tags: ["User"],
description: "Get user by id",
parameters: [
{
name: "id",
in: "path",
schema: {
$ref: "#/components/schemas/id",
},
required: true,
description: "A single user id",
}
],
responses: {
200: {
description: "Success",
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/User",
}
}
}
},
400: {
description: "Bad request"
},
404: {
description: "User with specified id does not exist"
},
500: {
description: "Internal server error"
}
}
},
put: {
tags: ["User"],
description: "Update user",
parameters: [
{
name: "id",
in: "path",
schema: {
$ref: "#/components/schemas/id", // data model of the param
},
required: true,
description: "A single user id",
}
],
requestBody: {
content: {
"application/json": {
schema: {
type: "object",
properties: {
name: {
type: "string"
},
email: {
type: "string"
},
password: {
type: "string"
}
}
}
}
}
},
responses: {
200: {
description: "User updated successfully",
},
400: {
description: "Invalid input parameters",
},
500: {
description: "Server error",
}
}
},
patch: {
tags: ["User"],
description: "Update user",
parameters: [
{
name: "id",
in: "path",
// schema: {
// $ref: "#/components/schemas/id", // data model of the param
// },
required: true,
description: "A single user id",
}
],
requestBody: {
content: {
}
},
responses: {
}
},
delete: {
tags: ["User"],
description: "Delete user",
parameters: [
{
name: "id",
in: "path",
schema: {
$ref: "#/components/schemas/id",
},
required: true,
},
],
responses: {
204: {
description: "User deleted successfully",
},
400: {
description: "You need to provide valid Id'",
},
404: {
description: "User not found",
},
500: {
description: "Internal server error",
},
},
}
},
'/auth/token': {
post: {
tags: ["Token"],
description: "Log in user",
parameters: [],
requestBody: {
content: {
"application/json": {
schema: {
type: "object",
properties: {
email: {
type: "string"
},
password: {
type: "string"
}
}
}
}
}
},
responses: {
201: {
description: "User logged in successfully!"
},
400: {
description: "Wrong credentials!"
},
500: {
description: "Internal server error"
}
}
}
},
'/auth/logout': {
post: {
tags: ["Token"],
description: "Log out user",
parameters: [],
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/Token"
}
}
}
},
responses: {
201: {
description: "User logged out successfully"
},
404: {
description: "No user has the token provided!"
},
500: {
description: "Internal server error"
}
}
}
},
'/auth/refresh': {
post: {
tags: ["Token"],
description: "Log out user",
parameters: [],
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/Token"
}
}
}
},
responses: {
201: {
description: "User refreshed successfully"
},
404: {
description: "Token not valid!"
}
}
}
}
},
components: {
schemas: {
id: {
type: "string",
description: "An id of a user"
},
User: {
type: "object",
properties: {
name: {
type: "string"
},
email: {
type: "string"
},
password: {
type: "string"
},
tokens: {
type: "array",
items: {
type: "string"
}
}
}
},
Token: {
type: "object",
properties: {
token: {
type: "string"
},
userId: {
type: "string"
}
}
}
}
}
}

Write Preview
Loading…
Peruuta
Tallenna