api html
1.0.0
تحويل أي مواصفات API إلى موقع توثيق HTML رائع
واجهة برمجة التطبيقات HTML
npm i api-html -g
api-html --url https://petstore.swagger.io/v2/swagger.json
تجريبي
سيقوم الأمر أعلاه بتحويل url المحدد إلى موقع ويب ثابت في الدليل الحالي باسم دليل dist .
هناك أيضًا إمكانية لتمرير file بدلاً من url .
| بارام | قصير | مطلوب | القيمة الافتراضية | تفاصيل |
|---|---|---|---|---|
--file | -f | required | باطل | المسار إلى ملف مصدر محلي، --file أو --url مطلوب في نفس الوقت. |
--url | -u | required | باطل | مطلوب عنوان URL لملف مصدر عبر الإنترنت، --file أو --url on في نفس الوقت. |
--type | -t | خياري | swagger | النوع المشفر لمواصفات واجهة برمجة التطبيقات، مثل swagger أو openapi أو api_blueprint أو io_docs أو google أو raml أو wadl |
--version | -v | خياري | 2 | إصدار OpenAPI ( swagger )، القيم المحتملة هي 1 أو 2 أو 3. ينطبق فقط على swagger |
--yaml | -y | خياري | 0 | إذا كان نوع الملف المصدر هو yaml ، فيجب أن تكون القيمة 1 ، ولا تنطبق إلا على swagger |
--option | -o | خياري | ./options.json | المسار إلى ملف الخيارات، راجع التفاصيل أدناه |
api-html --yaml 1 --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v2.0/yaml/api-with-examples.yaml
# A Swagger (OpenAPI) version 2 source file with yaml type
api-html --version 3 --url https://api.gettyimages.com/swagger/v3/swagger.json
# A Swagger (OpenAPI) version 3 source file with json type
api-html --version 3 --yaml 1 --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml
# A Swagger (OpenAPI) version 3 source file with yaml type
api-html --type api_blueprint --url https://raw.githubusercontent.com/apiaryio/api-blueprint/master/examples/Polls%20API.md
# An API Blueprint source file
api-html --type google --url https://www.googleapis.com/discovery/v1/apis/translate/v2/rest
# A Google API descory source file
api-html --type raml --url https://raw.githubusercontent.com/raml-apis/XKCD/master/api.raml
# A RAML source file
api-html --type io_docs --url https://raw.githubusercontent.com/lucybot/api-spec-converter/master/test/input/io_docs/foursquare.json
# An IO Docs source file
يجب أن تكون الخيارات في ملف json، إذا لم تقم بتمرير المعلمة --option ، فسنقوم بالتحقق من الدليل الحالي باسم options.json .
| اسم | القيمة الافتراضية | وصف |
|---|---|---|
theme | compact | قم بتعيين سمة واجهة المستخدم، والقيم هي: "مضغوط" و"أساسي". |
baseColor | #6e9a04 | قم بتعيين اللون الأساسي للموضوع |
textColor | #FFF | تعيين لون النص للموضوع |
logo | "شعار التباهي" | قم بتوجيه الشعار إلى ملف محلي |
logoUrl | '' | قم بتوجيه الشعار إلى عنوان URL |
isCoding | true | إظهار أو إخفاء قسم الترميز في الطلب |
isSearch | true | إظهار أو إخفاء خاصية البحث |
isTryRequest | true | إظهار أو إخفاء زر "تجربة" في الطلب |
isBackToTopButton | true | إخفاء أو إظهار زر BackToTop |
isCreditLink | true | إخفاء أو إظهار رابط Credit أسفل شريط التنقل |
pageTitle | title من ملف swagger.json | قم بتعيين عنوان الصفحة الموضح على شريط عنوان المتصفح. |
customHeadScript | '' | أضف برنامجًا نصيًا مخصصًا إلى علامة الرأس |
customFootScript | '' | أضف برنامجًا نصيًا مخصصًا إلى علامة القدم |
pageTags | '' | تمثيل الكلمات الرئيسية الوصفية للصفحة، ويجب فصل كل كلمة رئيسية بفاصلة. الكلمات الرئيسية التعريفية مفيدة لتحسين محركات البحث للصفحة. |
pageDescription | '' | تمثيل الوصف التعريفي للصفحة |
apiVersions | '' | إصدارات API، أدخل بالتنسيق التالي: (الاسم)[URL] (الاسم)[URL] ... الخبرة: (V1)[https://zamacall.io/docs/v1/] (V2)[https://zamacall.io/docs/v2/] |
headerMenuItems | '' | عناصر القائمة الرئيسية، أدخل بالتنسيق التالي: (الاسم)[URL] (الاسم)[URL] ... الخبرة: (الموقع الرئيسي)[https://zamacall.io] (اتصل بنا)[https://zamacall.io/contact/] |
{
"logo": "logo.svg",
"baseColor": "blue"
}
IO DocsWADLRAMLGoogle API DescoryAPI BlueprintYAMLOpenAPI (swagger) 1 و2 و3.cURL و Node و Python و JavaScriptقضايا جيثب
