在 js 代码中使用注释来书写,十分不方便:
所以,我认为更好的方案是直接使用YAML
文件来配置。
- 在根目录新建
docs/front
和docs/admin
目录,分别用来存放前台和后台的接口文档。
- 新建
docs/admin/articles.yaml
文件
openapi: 3.0.0
info:
title: Sample API
description: 长乐未央教学使用
version: 0.0.1
servers:
- url: http://localhost:3000
description: 开发环境
- url: https://clwy.cn
description: 生产环境
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: token
sche...