{"repo":"omermecitoglu/next-openapi-json-generator","free":true,"listed":false,"github":"https://github.com/omermecitoglu/next-openapi-json-generator","clone":"git clone https://github.com/omermecitoglu/next-openapi-json-generator.git","description":"a Next.js plugin to generate OpenAPI documentation from route handlers","language":"TypeScript","stars":21,"topics":["generator","next","nextjs","openapi","openapi-json","self-documenting","swagger","swagger-json","ts","typescript"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"Next OpenAPI JSON Generator Overview Next OpenAPI JSON Generator is an open-source Next.js plugin that extracts and generates OpenAPI JSON specifications from your route handlers defined using @omer-x/next-openapi-route-handler . It simplifies the process of generating and maintaining OpenAPI documentation by leveraging TypeScript and Zod schemas. Key Features: - Automated OpenAPI Generation : Automatically generates OpenAPI JSON specs from your route handlers. - TypeScript Integration : Seamlessly integrates with TypeScript for strong type-checking. - Zod Schema Support : Uses Zod schemas for validation and generates JSON schemas for OpenAPI. - Next.js Compatibility : Works seamlessly with Next.js and integrates with other server-side libraries. Note: This package works in conjunction with Next OpenAPI Route Handler to extract the generated OpenAPI JSON. Requirements To use @omer-x/next-openapi-json-generator , you'll need the following dependencies in your Next.js project: - Next.js = v13 - Zod = v3 - Next OpenAPI Route Handler Installation To install this package, along with its peer dependency, run: Usage The generateOpenApiSpec function is used to extract and generate the OpenAPI JSON specification from your defined models. Here's a description of how to use it: Example Parameters The generateOpenApiSpec function takes an object with the following properties: Property Type Description -------- ------------------------------------------ -----------------------------------","default_branch":null,"files":null,"tree":[],"storefront":"/r/omermecitoglu","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/omermecitoglu/next-openapi-json-generator/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}