【文件属性】:
文件名称:open-api-repo
文件大小:188KB
文件格式:ZIP
更新时间:2021-04-01 22:42:05
Shell
Yanport API OpenAPI定义
处理您的OpenAPI定义
安装
安装 。
克隆此仓库,并在npm install根目录中运行npm install 。
用法
npm start
启动参考文档预览服务器。
npm run build
将定义捆绑到dist文件夹。
npm test
验证定义。
贡献指南
以下是示例贡献指南。 存储库中的工具并不限制您使用任何特定的结构。 调整贡献指南以匹配您自己的结构。 但是,如果您不考虑结构,那么这是一个不错的起点。
如果您调整文件/文件夹的组织结构,请更新此贡献指南。
.redocly.yaml控制各种工具(包括lint工具和参考docs引擎)的设置。 打开它以查找示例,并以获取更多信息。
模式
添加架构
导航到openapi/components/schemas文件夹。
添加一个您希望为架构命名的文件。
定义架构。
使用$