search
githubEdit

註解寫在Code內生成swagger UI

hashtag
註解寫在Code內生成swagger UI

hashtag
安裝

yarn add swagger-jsdoc swagger-ui-express swagger-model-validator

hashtag
使用

  1. 新增： /router/swagger.js

const express = require('express')
const router = express.Router()

const options = {
  swaggerDefinition: {
    info: {
      title: 'REST - Swagger',
      version: '1.0.0',
      description: 'REST API with Swagger doc',
      contact: {
        email: ''
      }
    },
    tags: [
      {
        name: 'AMSS5',
        description: 'AMSS5 API'
      }
    ],
    schemes: ['http'],
    host: 'localhost:3124',
    basePath: '/api'
  }, // 下面記得要寫上要讀哪邊的註解
  apis: ['./router/grid.js', './router/project.js', './router/user.js', './database/schemas/grid.js']
}

const swaggerJSDoc = require('swagger-jsdoc')
const swaggerUi = require('swagger-ui-express')
const swaggerSpec = swaggerJSDoc(options)
require('swagger-model-validator')(swaggerSpec)

router.get('/json', function (req, res) {
  res.setHeader('Content-Type', 'application/json')
  res.send(swaggerSpec)
})

router.use('/', swaggerUi.serve, swaggerUi.setup(swaggerSpec))

function validateModel (name, model) {
  const responseValidation = swaggerSpec.validateModel(name, model, false, true)
  if (!responseValidation.valid) {
    console.error(responseValidation.errors)
    throw new Error(`Model doesn't match Swagger contract`)
  }
}

module.exports = router;

2.綁定swagger UI router

server.js

  1. API 文件

  1. Model 文件

5.瀏覽 swagger UI

http://localhost:3000/swagger/api#/arrow-up-right

port 為你 server 的 port

參考至：https://danielpecos.com/2017/09/06/rest-api-with-node-js-and-swagger/arrow-up-right

6.瀏覽產生出的swagger.json

https://localhost:3000/swagger/jsonarrow-up-right

hashtag
加入Redoc

Redoc提供更完整的文件頁面

https://github.com/Redocly/redocarrow-up-right

使用方式

在html加入如下

把上面的swagger.json替換為你的即可

PreviousswaggerNextJavascript 實用Lib

Last updated