Longbridge OpenAPI docs

本地开发环境搭建

# 安装依赖
$ yarn

# 启动 docusaurus 服务
$ yarn dev

# 启动监听 swagger 文档转成 markdown 文件服务
$ yarn dev:swagger

目录结构

.
├── README.md
├── docs // 所有文档都在这个目录下
├── swagger-docs // 所有 swagger 文档都在这个目录
├── templates // swagger 文档转换成 markdown 模板配置文件
├── i18n // 多语言配置文件
├── src // 一般不用修复个目录文件。
├── convert-md.js // 将 swagger 文档转换为 markdown 的脚本文件
├── sidebars.js // 文档侧边栏配置文件
├── docusaurus.config.js // 一般情况下不用修改
├── tsconfig.json
├── package.json
└── yarn.lock

文档编写

NOTE: 最好用 VS Code 开发，此项目带有 .vscode 内置 VS Code 插件和配置推荐，用 VS Code 编写，能启动自动格式化功能。

Swagger 格式文档

支持在线编辑 Swagger Editor 将编辑后的文档拷贝到 swagger-docs 对应目录下

Swagger 文档规范

Markdown 格式文档

OpenAPI 文档规范

项目依赖

项目目前采用第三方框架 Docusaurus 构建

文档需要遵守以下规范：

• 遵循中英文书写规范，中英文加空格间隔，正确使用标点符号，正确用词，精确专业术语用词、大小写。
• 文档规范 https://longbridge.feishu.cn/wiki/wikcnb0RtZ8OEuAodGBXaOL6Nxh
• Markdown 文档需要提供规范的 Meta 信息

Markdown Meta 信息格式

只针对非 Swagger 生成的 Markdown 文档

在每个 .md 文件的开头添加内容（示例）：

---
title: '开放平台文档标题'
id: $category_$file_name # category 指文檔分類 file_name 指文档的文件名以中横线分隔的字符串
slug: '/xxx' # 注意前面必须加上 /， 例如 /trade-order-create 这样的 slug 保持和 id 一致
---

Markdown 文档分类

只针对非 Swagger 生成的 Markdown 文档

为了将文档进行分类需要在 docs 中每个子目录添加 category.json 配置文件，文件内容如下：

{
  position: 1, // 显示的顺序，数字越小越靠前
  label: 'OpenAPI 介绍', // 文档分类名称，显示在左边栏
  link: {
    title: 'Getting started', // 点击分类时页面的描述信息
    slug: '/getting-started', //
  },
}

特别提示

Markdown 涉及到的静态资源例如：图片、视频等都需要上传到 CDN 再引用，不要放到项目中引用。

不推荐的写法（这样定义会导致加载资源失败的情况）

![流程图片](../../static/xxxx.png)

推荐的写法（从后台上传到 CDN 拿到 CDN 地址，然后在 Markdown 中引用）

![流程图片](https://pub.lbkrs.com/xxx/xxx.png)

Before commit you should be run autocorrect --fix . first How to use autocorrect