Skip to content

mohamed-boussaidi/generate-next-pages

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

generate-next-pages generates Next Crud Pages from static OpenAPI schemas quickly using only Node.js. It is fast, lightweight, (almost) dependency-free.

Features

  • ✅ Supports OpenAPI 3.0 and 3.1 (including advanced features like discriminators)
  • ✅ Generate runtime-free types that outperform old-school codegen
  • ✅ Generate Next Crud Pages
  • ✅ Native Node.js code is fast and generates Pages within milliseconds

Setup openapi-typescript

This library requires the latest version of Node.js installed (18.x or higher recommended). With that present, run the following in your project:

npm i -D openapi-typescript

Setup generate-next-pages

npm i -D @m.boussaidi/generate-next-pages

Basic usage

First, generate a local type file by running npx openapi-typescript:

npx openapi-typescript https://myapi.dev/api/v1/openapi.yaml -o ./types/index.d.ts
# 🚀 ./path/to/my/schema.yaml -> ./types/index.d.ts [7ms]

⚠️ Be sure to validate your schemas! generate-next-pages will err on invalid schemas.

Second, generate crud pages by running npx @m.boussaidi/generate-next-pages:

npx @m.boussaidi/generate-next-pages https://myapi.dev/api/v1/openapi.json -r pet  -o ./
# 🚀 https://myapi.dev/api/v1/openapi.json -> ./pages/pet [7ms]

⚠️ Be sure to validate your schemas! generate-next-pages will err on invalid schemas.

Thanks, @mohamed-boussaidi!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published