next swagger doc
v0.4.0
Gere Swagger JSON API das rotas da API NextJS
Se você gosta de trabalhar com o próximo doc, você vai adorar válvulas nas próximas: NextJs API, suporte Zod, Yup, Validador mais rápido, Joi e muito mais
Este pacote lê seu código-fonte anotado por JSDOC na rota da API NextJS e gera uma especificação OpenAPI (Swagger).
NextJs + Swagger-JSdoc = Next-Swagger-Doc
yarn add next-swagger-doc Para incorporar next-swagger-doc no seu projeto Next.JS 13, siga estas etapas. Essa configuração gerará documentação de swagger para sua API com base no seu código e fornecerá uma interface do usuário interna para visualizar a documentação.
Em seguida, crie um novo arquivo lib/swagger.ts . Este arquivo usa a biblioteca next-swagger-doc para criar uma especificação de swagger com base nas rotas da API no seu projeto 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 ;
} ; Gere um novo arquivo chamado app/api-doc/react-swagger.tsx . Neste arquivo, crie e exporte um componente REACT que utilize a biblioteca swagger-ui-react para renderizar a interface do usuário de swagger de acordo com a especificação fornecida.
Para fins de demonstração, aqui está um exemplo usando swagger-ui-react
Sinta -se à vontade para empregar qualquer biblioteca alternativa da interface do usuário do Swagger, como o Stoplightio/Elements. Eu adicionei um exemplo usando esta biblioteca na pasta 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 ; Crie um novo app/api-doc/page.tsx . Esta página importa a especificação Swagger e o componente Swagger UI para exibir a documentação do 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 >
) ;
} Por fim, adicione um comentário de arrogância à sua rota da API no app/api/hello/route.ts . Este comentário inclui metadados sobre o endpoint da API, que será lido pelo next-swagger-doc e incluído nas especificações 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 ,
} ) ;
} Agora, navegue para localhost:3000/api-doc (ou onde quer que você hospede seu próximo aplicativo.js) e você verá a interface do usuário do 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 Em seguida, abra http: // localhost: 3000/api-doc ou http: // localhost: 3000/no seu navegador 
Para definir uma regra de Eslint que verifica se todas as APIs realmente têm uma descrição de Swagger JSDOC, podemos usar as seguintes configurações:
Instale o plugin JSDOC ESLINT:
yarn add -D eslint-plugin-jsdocCrie a regra personalizada em seu arquivo de configuração de 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 "
}
]
}
]
}
]
}Este projeto usa o pré-compromisso para aplicar a qualidade do código. Para instalar ganchos pré-comprometidos, execute:
pre-commit install? Huynh Duc Dung
Dê a um ️ se este projeto o ajudar!
Obrigado a essas pessoas maravilhosas (key emoji):
Dung Duc Huynh (Kaka) | Tmirkovic | Matthew Holloway | Leventemihaly | Pahrizal Ma'rup | Aris | Valerio Ageno |
Cachho |
Este projeto segue a especificação de todos os contribuintes. Contribuições de qualquer tipo de boas -vindas!
