next swagger doc
v0.4.0
قم بإنشاء Swagger JSON API من طرق API NextJS
إذا كنت تستمتع بالعمل مع Swagger-Doc ، فستحب القياسات التالية: NextJS API.
تقرأ هذه الحزمة رمز المصدر المصنوع من JSDOC على مسار API NextJS وإنشاء مواصفات OpenAPI (Swagger).
NextJS + Swagger-JSdoc = Next-Swagger-Doc
yarn add next-swagger-doc لدمج next-swagger-doc مع مشروع Next.js 13 ، اتبع هذه الخطوات. سيقوم هذا الإعداد بإنشاء وثائق Swagger لواجهة برمجة التطبيقات الخاصة بك استنادًا إلى الكود الخاص بك وتوفير واجهة مستخدم Swagger مدمجة لعرض الوثائق.
بعد ذلك ، قم بإنشاء ملف جديد lib/swagger.ts . يستخدم هذا الملف مكتبة next-swagger-doc لإنشاء مواصفات Swagger بناءً على طرق API في مشروع Next.js الخاص بك.
import { createSwaggerSpec } from "next-swagger-doc" ;
export const getApiDocs = async ( ) => {
const spec = createSwaggerSpec ( {
apiFolder : "app/api" , // define api folder under app folder
definition : {
openapi : "3.0.0" ,
info : {
title : "Next Swagger API Example" ,
version : "1.0" ,
} ,
components : {
securitySchemes : {
BearerAuth : {
type : "http" ,
scheme : "bearer" ,
bearerFormat : "JWT" ,
} ,
} ,
} ,
security : [ ] ,
} ,
} ) ;
return spec ;
} ; قم بإنشاء ملف جديد باسم app/api-doc/react-swagger.tsx . في هذا الملف ، قم بإنشاء وتصدير مكون React الذي يستخدم مكتبة swagger-ui-react لتقديم واجهة المستخدم Swagger وفقًا للمواصفات المقدمة.
لأغراض العرض التوضيحي ، إليك مثال باستخدام Swagger-Ui React
لا تتردد في استخدام أي مكتبة واجهة مستخدم Swagger بديلة ، مثل StopLightio/Elements. لقد أضفت مثالاً باستخدام هذه المكتبة في مجلد example .
'use client' ;
import SwaggerUI from 'swagger-ui-react' ;
import 'swagger-ui-react/swagger-ui.css' ;
type Props = {
spec : Record < string , any > ,
} ;
function ReactSwagger ( { spec } : Props ) {
return < SwaggerUI spec = { spec } /> ;
}
export default ReactSwagger ; قم بإنشاء app/api-doc/page.tsx . تستورد هذه الصفحة مواصفات Swagger ومكون واجهة المستخدم Swagger لعرض وثائق Swagger.
import { getApiDocs } from "@/lib/swagger" ;
import ReactSwagger from "./react-swagger" ;
export default async function IndexPage ( ) {
const spec = await getApiDocs ( ) ;
return (
< section className = "container" >
< ReactSwagger spec = { spec } />
</ section >
) ;
} أخيرًا ، أضف تعليق Swagger إلى مسار API الخاص بك في app/api/hello/route.ts . يتضمن هذا التعليق بيانات تعريف حول نقطة نهاية API التي سيتم قراءتها بواسطة next-swagger-doc وتضمينها في مواصفات Swagger.
/**
* @swagger
* /api/hello:
* get:
* description: Returns the hello world
* responses:
* 200:
* description: Hello World!
*/
export async function GET ( _request : Request ) {
// Do whatever you want
return new Response ( 'Hello World!' , {
status : 200 ,
} ) ;
} الآن ، انتقل إلى localhost:3000/api-doc (أو في أي مكان تستضيفه تطبيق Next.js) ، ويجب أن ترى واجهة المستخدم Swagger.
yarn add next-swagger-doc swagger-ui-reactpages/api-doc.tsx import { GetStaticProps , InferGetStaticPropsType } from 'next' ;
import { createSwaggerSpec } from 'next-swagger-doc' ;
import dynamic from 'next/dynamic' ;
import 'swagger-ui-react/swagger-ui.css' ;
const SwaggerUI = dynamic < {
spec : any ;
} > ( import ( 'swagger-ui-react' ) , { ssr : false } ) ;
function ApiDoc ( { spec } : InferGetStaticPropsType < typeof getStaticProps > ) {
return < SwaggerUI spec = { spec } / > ;
}
export const getStaticProps : GetStaticProps = async ( ) => {
const spec : Record < string , any > = createSwaggerSpec ( {
apiFolder : 'pages/api' // or 'src/pages/api',
definition : {
openapi : '3.0.0' ,
info : {
title : 'Next Swagger API Example' ,
version : '1.0' ,
} ,
} ,
} ) ;
return {
props : {
spec ,
} ,
} ;
} ;
export default ApiDoc ; pages/api/doc.ts import { withSwagger } from "next-swagger-doc" ;
const swaggerHandler = withSwagger ( {
definition : {
openapi : "3.0.0" ,
info : {
title : "NextJS Swagger" ,
version : "0.1.0" ,
} ,
} ,
apiFolder : "pages/api" ,
} ) ;
export default swaggerHandler ( ) ;pages/api/hello.ts import { NextApiRequest , NextApiResponse } from "next" ;
/**
* @swagger
* /api/hello:
* get:
* description: Returns the hello world
* responses:
* 200:
* description: hello world
*/
const handler = ( _req : NextApiRequest , res : NextApiResponse ) => {
res . status ( 200 ) . json ( {
result : "hello world" ,
} ) ;
} ;
export default handler ;next-swagger-doc.json {
"apiFolder" : " pages/api " ,
"schemaFolders" : [ " models " ],
"definition" : {
"openapi" : " 3.0.0 " ,
"info" : {
"title" : " Next Swagger API Example " ,
"version" : " 1.0 "
}
}
}yarn next-swagger-doc-cli next-swagger-doc.jsongh repo clone jellydn/next-swagger-doc
cd examples/next14-app
pnpm install
pnm run dev ثم افتح http: // localhost: 3000/api-doc أو http: // localhost: 3000/on browser 
من أجل تعيين قاعدة ESLINT تتحقق من أن جميع واجهات برمجة التطبيقات لديها بالفعل وصف SWAGRATION JSDOC يمكننا استخدام الإعدادات التالية:
قم بتثبيت البرنامج المساعد JSDOC ESLINT:
yarn add -D eslint-plugin-jsdocقم بإنشاء القاعدة المخصصة في ملف تكوين ESLINT الخاص بك:
{
//...your configuration
"overrides" : [
//...your overrides
{
// Force the setting of a swagger description on each api endpoint
"files" : [ " pages/api/**/*.ts " ],
"plugins" : [ " jsdoc " ],
"rules" : {
"jsdoc/no-missing-syntax" : [
" error " ,
{
"contexts" : [
{
"comment" : " JsdocBlock:has(JsdocTag[tag=swagger]) " ,
"context" : " any " ,
"message" : " @swagger documentation is required on each API. Check this out for syntax info: https://github.com/jellydn/next-swagger-doc "
}
]
}
]
}
]
}يستخدم هذا المشروع اللبلاب المسبق لفرض جودة الرمز. لتثبيت السنانير قبل الالتزام ، قم بتشغيل:
pre-commit install؟ Huynh Duc Dung
إعطاء ️ إذا ساعدك هذا المشروع!
شكراً لهؤلاء الأشخاص الرائعين (مفتاح الرموز التعبيرية):
Dung Duc Huynh (Kaka) | tmirkovic | ماثيو هولواي | Leventemihaly | Pahrizal Ma'upr | آريس | فاليريو أغنو |
Cachho |
يتبع هذا المشروع مواصفات جميع المساهمين. مساهمات من أي نوع ترحيب!
