npmpackage.info

@scalar/nextjs-openapi

Scalar is an open-source API platform:　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　🌐 Modern Rest API Client　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　📖 Beautiful API References　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　✨ 1st-Class OpenAPI/Swagger Support

0.1.2

9,358

MIT

TypeScript

19.17 kB

4,714

Installations

npm install @scalar/nextjs-openapi

Developer Guide

BETA

Typescript

No

Module System

ESM

Min. Node Version

>=18

Node Version

20.18.3

NPM Version

10.8.2 Score

33.2

Supply Chain

52.6

Quality

98.9

Maintenance

100

Vulnerability

92.1

License

Pull Requests

Open

15

Total

3,846

Closed

371

Merged

3,460

Issues

Open

204

Total

919

Closed

715

Releases

Unable to fetch releases

Contributors

107

Unable to fetch Contributors

View All 107 Contributors

Languages

TypeScript

Vue

CSS

JavaScript

Python

HTML

Dockerfile

Shell

MDX

TypeScript (67.09%)

Vue (24.46%)

C# (2.94%)

CSS (2.91%)

Go (0.63%)

JavaScript (0.5%)

Python (0.49%)

HTML (0.47%)

Dockerfile (0.31%)

Shell (0.1%)

MDX (0.1%)

validate.email 🚀

Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.

Developer

scalar

Download Statistics

Total Downloads

4,714

Last Day

290

Last Week

713

Last Month

2,180

Last Year

4,714

GitHub Statistics

MIT License

9,358 Stars

4,100 Commits

314 Forks

27 Watchers

189 Branches

107 Contributors

Updated on Mar 15, 2025

Maintainers

Package Meta Information

Latest Version

0.1.2

Package Id

@scalar/nextjs-openapi@0.1.2

Unpacked Size

19.17 kB

Size

6.25 kB

File Count

NPM Version

10.8.2

Node Version

20.18.3

Published on

Mar 14, 2025

Oops! Something went wrong.

Dependencies

fast-glob @scalar/nextjs-api-reference @scalar/types @scalar/ts-to-openapi

Dev Dependencies

@types/node @types/react @types/react-dom next openapi-types @scalar/build-tooling

[PRE-ALPHA] Scalar Next.js API Reference Handler

This plugin automatically generates an OpenAPI schema file based on a Next.js API.

Installation

1npm install @scalar/nextjs-openapi

Usage

Currently this plugin is strictly for the app router with typescript. Currently we generate the spec from the Request/Context types as well as the returns in the HTTP method. You can find a simple example in the playground folder.

Also is currently under heavy development, all API's are likely to change. However we are looking for feedback! If you have an open API OR would like to share a private one, let us know so we can test the integration with it.

You just need to drop this file into the app/api/openapi/[[...openapi]] folder. You can rename the openapi folder to whatever you like but the dynamic folder must be catch-all as we will be serving two endpoints.

1// app/api/openapi/[[...slug]]/route.ts
2import { OpenAPI } from '@scalar/nextjs-openapi'
3
4export const GET = OpenAPI()

No vulnerabilities found.

No security vulnerabilities found.

Other packages similar to @scalar/nextjs-openapi

@scalar/nextjs-api-reference

0.7.2

a Next.js component to render API references from an OpenAPI file