microService-node
  • 简介
  • NodeJS 简介
  • 开发资料与规范
    • OpenAPI 规范
    • Google API 规范
    • ES6/ES7/ES8语法
    • JavaScript 编码规范
    • JavaScript/Nodejs 教程
    • 开发规范
      • 应用错误处理
  • 框架使用
    • nodejs 安装
    • 定义 openapi.json 文件
    • 认证和授权
    • 开发技巧
      • 浅拷贝与深度克隆
      • Class 类
      • ES6中常用的语法
      • Promise 对象
  • 架构模块
    • restify
      • 快速入门
      • API
        • Server API
        • Request API
        • Response API
        • Plugins API
      • 指导
    • restify-errors 模块
    • WebSocket（Socket.IO）
    • Bunyan - 日志模块
    • swagger-routes - 路由模块
    • swagger-test-templates模块
    • typescript 模块
    • APM
  • 开发模块
    • Elasticsearch
    • knex
    • joi（数据校验）
    • PM2 常用命令与监控
    • 附录：资料
  • 单元测试相关模块
    • Chai
    • Mocha
    • mocha-junit-reporter
    • SuperTest
    • z-schema
    • nyc - 代码覆盖率
    • Sinon
    • mockserver
    • 资料
  • 其他模块
    • node-schedule（定时任务）
    • nodemon 自动发布（热发布）的工具
    • moment（日期处理）
    • Lebab（ES5转ES6）
    • object-path
    • underscore（js实用工具库）
    • ESLint（代码检测）
    • oauth2-server
  • 附录：package.json
  • 附录：WebStorm
  • 附录：.gitignore/npmignore
  • 附录：nodejs 调试
  • 附录：资料
  • 附录:npm命令与发布npm包
  • 下一代框架－LoopBack
  • UmiJS
    • ReactJS
  • nest 框架
  • egg.js
    • 基础入门
    • Egg.js 目录结构介绍
    • 路由 / 传值 / 模板引擎
    • controller/service
    • extend扩展
    • 中间件（Middleware）
    • Cookie 的使用
    • Session 的使用
    • CSRF安全机制
    • 资料收集
  • 资料
Powered by GitBook
On this page
  • 其他辅助工具
  • 资料

Was this helpful?

  1. 框架使用

定义 openapi.json 文件

Previousnodejs 安装Next认证和授权

Last updated 5 years ago

Was this helpful?

可以使用swagger官方的editor编辑工具视图化编辑，地址： ， 不但可以实时看到效果，还可以帮你检查语法错误。

目前openapi最新版本为3.0.2

我们定义的版本为3.0.0

其中定义的相关语法可以参考：

其他辅助工具

资料

http://editor.swagger.io/
https://github.com/OAI/OpenAPI-Specification/tree/master/versions
_Swagger _Editor
yaml 转json 工具
json 格式化工具
Data Models (Schemas)
Swagger 2与OpenAPI 3
OpenAPI 3.0.0 通过SwaggerHub编写接口文档