chevron_left

Express 实践教程

免费
第 3.2 回

教程文档

Express 实践教程 - 使用 YAML 配置文件

2023年11月13日
Express 实践教程

使用 YAML 配置文件

在 js 代码中使用注释来书写,十分不方便:

  • 造成代码混乱
  • 缩进困难
  • 复制官方文档配置困难

所以,我认为更好的方案是直接使用YAML文件来配置。

  • 在根目录新建docs/frontdocs/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...

课程介绍