An elegant and simple OpenAPI Documentation project based on VuePress + MarkDown
Through the capabilities provided by
vuepress, This is an online web document that can be quickly built by focusing on writing markdown documents. We use it to build project manuals and OpenAPI documents.
-
If you are keen on maintaining API documentation by hand, this repo may be for you. If you prefer Swagger UI-like simplicity, well...
-
Imitation of the API interface document layout of the Feishu open platform
-
Since it is written in standard
MarkDown(HTML), it is easy to integrate your own projects
- List the key file contents. If it is deeply integrated, it is recommended to learn about vuepress
.
├── .gitignore
├── README.md
├── docs
│ ├── .vuepress
│ │ ├── client.ts
│ │ ├── config.ts // configuration management
│ │ └── public
│ ├── index.md
│ ├── infra
│ │ ├── assets
│ │ │ └── images
│ │ ├── note
│ │ │ ├── 01.md
│ │ │ ├── 02.md
│ │ │ └── 03.md
│ │ ├── open-api // your api docs
│ │ │ ├── access-token.md
│ │ │ ├── create-project.md
│ │ │ ├── delete-project.md
│ │ │ ├── list-project.md
│ │ │ ├── overview.md
│ │ │ ├── query-project.md
│ │ │ └── update-project.md
│ │ └── project.md
│ └── zh
├── package.json
└── yarn.lock- Run the perl script in the root path of the project
➜ elegant-api-docs git:(master) ./start.pl
1. Build Environment
yarn install v1.22.19
[1/4] 🔍 Resolving packages...
[2/4] 🚚 Fetching packages...
[3/4] 🔗 Linking dependencies...
[4/4] 🔨 Building fresh packages...
✨ Done in 1.55s.
2. Startup project
yarn run v1.22.19
$ vuepress dev docs --config docs/.vuepress/config.ts
✔ Initializing and preparing data - done in 175ms
Port 8080 is in use, trying another one...
vite v3.1.8 dev server running at:
➜ Local: http://localhost:8081/docs/- API documentation style
- A multi-level request body display example
- Standard and unified response body format, as well as troubleshooting suggestions
