next swagger doc
v0.4.0
Генерировать Swagger JSON API с маршрутов NextJS API
Если вам понравится работать с следующим сэггерным DOC, вам понравятся следующие значения: NextJS API-валидации, поддержка ZOD, YUP, самый быстрый Validator, JOI и многое другое
Этот пакет считывает ваш исходный код, аннотируемый JSDOC по маршруту API NextJS и генерирует спецификацию OpenAPI (Swagger).
NextJs + Swagger-jsdoc = Next-Swagger-Doc
yarn add next-swagger-doc Чтобы включить next-swagger-doc с вашим проектом Next.js 13, выполните следующие действия. Эта настройка генерирует документацию Swagger для вашего API на основе вашего кода и предоставит встроенный интерфейс Swagger для просмотра документации.
Далее создайте новый файл lib/swagger.ts . В этом файле используется библиотека next-swagger-doc для создания спецификации чванства на основе маршрутов 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
Не стесняйтесь использовать любую альтернативную библиотеку UI 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 >
) ;
} Наконец, добавьте комментарий к чванству в свой маршрут API в app/api/hello/route.ts . Этот комментарий включает в себя метаданные о конечной точке API, которая будет прочитана next-swagger-doc и включен в Swagger Spec.
/**
* @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), и вы должны увидеть UI 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/в вашем браузере 
Чтобы установить правило Eslint, которое проверяет, что все API на самом деле имеют описание JSDOC Swagger, мы можем использовать следующие настройки:
Установите плагин 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) | Тмиркович | Мэтью Холлоуэй | Leventemihaly | Пахризал Ма'Рруп | Арис | Валерио Агено |
Каххо |
Этот проект следует за спецификацией всех контролей. Взносы любого вида приветствуются!
