Show Menu
Cheatography

Generating API Reference Documentation using Redocly CLI.

Алхмууд

Алхам 0
Доорх алхмуудыг эхлэхээсээ өмнө node.js -ийг локал компьютер дээрээ суулгасан байх
Алхам 1
openap­i-s­tarter projec­t-ийг клон хийх
Алхам 2
Redocly CLI суулгах
Алхам 3
API тайлбар файлаа бэлдэх
Алхам 4
API Docume­ntation гаргах

Step 1: Clone the openap­i-s­tarter project

Github account үүсгээд нэвтэрч орон openap­i-s­tarter projec­t-ийг clone хийгээд ямар нэг code editor tool дээр нээнэ.

Step 2 - Install Redocly CLI from openap­i-s­tarter

npm i
Дээрх мөр кодыг ажиллу­улна.
 

Step 3 - Prepare your API definition file

Жишээ (Swagger):
1.
Swagger дээрээс API тайлбар JSON мэдээллийг агуулсан холбоосыг олно.
2.
Уг файлаа swager editor дээр хуулаад YAML руу хөрвүүлнэ.
3.
Хэрэв API тодорх­ойлолт нь OpenAP­I-ийн 3 ба түүнээс дээш хувилбар дээр бичигд­ээгүй байвал Edit -> Convert to OpenAPI 3 -> Convert гэж хувилбарыг нь өсгөнө.
4.
File -> Save as YAML гэж хадгална.
Өөрийн API Docume­ntation гаргаж авахыг зорьж байгаа хэрэгл­үүрээс дэлгэр­энгүй мэдээллийг агуулсан тайлбар файлыг гаргаж авна. Энэ нь .yaml өргөтг­өлтэй файл байх ёстой.
 

Step 4 - Generate docume­ntation

1.
Бэлдсэн YAML файлаа клондсон openap­i-s­tarter projec­t-ийн openapi direct­ory-д байрлу­улна.
2.
Openap­i-s­tarter projec­t-ийн openapi directory дотроос дараах команд­уудыг ажиллу­улна.
3.
Файлаа bundle хийнэ.
$ redocly bundle api-fi­le-­nam­e.yaml --output bundle­d.yaml
4.
Bundle файлаа шалгана.
$ redocly lint bundle­d.yaml
Хэрэв алдаа гарч ирвэл зааврын дагуу засах ба амжилттай болсон бол цааш үргэлж­лүүлнэ.
5.
Нэг бүтэн bundle файлаа олон хэсэг болгож салгана.
$ redocly split bundle­d.yaml --outDir bundled
6.
Эцэст нь доорх кодыг ажиллуулан preview хуудсыг харж болно.
$ redocly previe­w-docs bundle­d.yaml
 

Comments

No comments yet. Add yours below!

Add a Comment

Your Comment

Please enter your name.

    Please enter your email address

      Please enter your Comment.

          Related Cheat Sheets

          Vimeo Advanced API Methods Cheat Sheet
          rSpec Core API and Mock API Cheat Sheet
          Unity 2D Basics Cheat Sheet