Cheatography
https://cheatography.com
Generating API Reference Documentation using Redocly CLI.
Алхмууд
Алхам 0 |
Доорх алхмуудыг эхлэхээсээ өмнө node.js -ийг локал компьютер дээрээ суулгасан байх |
Алхам 1 |
|
Алхам 2 |
Redocly CLI суулгах |
Алхам 3 |
API тайлбар файлаа бэлдэх |
Алхам 4 |
API Documentation гаргах |
|
Step 1: Clone the openapi-starter project
Github account үүсгээд нэвтэрч орон openapi-starter project-ийг clone хийгээд ямар нэг code editor tool дээр нээнэ. |
Step 2 - Install Redocly CLI from openapi-starter
Дээрх мөр кодыг ажиллуулна.
|
|
Step 3 - Prepare your API definition file
Жишээ (Swagger): |
1. |
Swagger дээрээс API тайлбар JSON мэдээллийг агуулсан холбоосыг олно. |
2. |
|
3. |
Хэрэв API тодорхойлолт нь OpenAPI-ийн 3 ба түүнээс дээш хувилбар дээр бичигдээгүй байвал Edit -> Convert to OpenAPI 3 -> Convert гэж хувилбарыг нь өсгөнө. |
4. |
File -> Save as YAML гэж хадгална. |
Өөрийн API Documentation гаргаж авахыг зорьж байгаа хэрэглүүрээс дэлгэрэнгүй мэдээллийг агуулсан тайлбар файлыг гаргаж авна. Энэ нь .yaml өргөтгөлтэй файл байх ёстой.
|
|
Step 4 - Generate documentation
1. |
Бэлдсэн YAML файлаа клондсон openapi-starter project-ийн openapi directory-д байрлуулна. |
2. |
Openapi-starter project-ийн openapi directory дотроос дараах командуудыг ажиллуулна. |
3. |
Файлаа bundle хийнэ. $ redocly bundle api-file-name.yaml --output bundled.yaml
|
4. |
Bundle файлаа шалгана. $ redocly lint bundled.yaml
Хэрэв алдаа гарч ирвэл зааврын дагуу засах ба амжилттай болсон бол цааш үргэлжлүүлнэ. |
5. |
Нэг бүтэн bundle файлаа олон хэсэг болгож салгана. $ redocly split bundled.yaml --outDir bundled
|
6. |
Эцэст нь доорх кодыг ажиллуулан preview хуудсыг харж болно. $ redocly preview-docs bundled.yaml
|
|
Created By
Metadata
Comments
No comments yet. Add yours below!
Add a Comment
Related Cheat Sheets