{"repo":"omermecitoglu/next-openapi-route-handler","free":true,"listed":false,"github":"https://github.com/omermecitoglu/next-openapi-route-handler","clone":"git clone https://github.com/omermecitoglu/next-openapi-route-handler.git","description":"a Next.js plugin to generate OpenAPI documentation from route handlers","language":"TypeScript","stars":52,"topics":["generator","next","nextjs","openapi","openapi-json","swagger","swagger-json","ts","typescript","self-documenting"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"Next OpenAPI Route Handler Overview Next OpenAPI Route Handler is an open-source, lightweight, and easy-to-use Next.js plugin designed to build type-safe, self-documented APIs. It leverages TypeScript and Zod to create and validate route handlers, automatically generating OpenAPI documentation from your code. This package aims to simplify the process of building and documenting REST APIs with Next.js, ensuring your API endpoints are well-defined and compliant with OpenAPI specifications. Key Features: - Type-Safe API Endpoints : Ensure your requests and responses are strongly typed with TypeScript. - Schema Validation : Use Zod schemas for object validation, automatically converted to JSON schema for OpenAPI. - Auto-Generated Documentation : Generate OpenAPI JSON specs from your route handlers. - Integration with Next.js : Works seamlessly with Next.js App Directory features. - Customizable : Compatible with existing Next.js projects and fully customizable to suit your needs. Note: This package has a peer dependency on Next OpenAPI JSON Generator for extracting the generated OpenAPI JSON. Requirements To use @omer-x/next-openapi-route-handler , you'll need the following dependencies in your Next.js project: - Next.js = v13 - Zod = v3 - Next OpenAPI JSON Generator Installation To install this package, along with its peer dependency, run: Usage The defineRoute function is used to define route handlers in a type-safe and self-documenting way. Below is a description of each prope","default_branch":null,"files":null,"tree":[],"storefront":"/r/omermecitoglu","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/omermecitoglu/next-openapi-route-handler/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."}