0.4.98 • Published 12 months ago

@scalar/nextjs-api-reference v0.4.98

Weekly downloads
-
License
MIT
Repository
github
Last release
12 months ago

Scalar Next.js API Reference Handler

Version Downloads License Discord

This plugin provides an easy way to render a beautiful API reference based on an OpenAPI/Swagger file with Next.js.

Installation

npm install @scalar/nextjs-api-reference

Usage

If you have a OpenAPI/Swagger file already, you can pass a URL to the plugin in an API Route:

// app/reference/route.ts
import { ApiReference } from '@scalar/nextjs-api-reference'

const config = {
  spec: {
    url: '/openapi.json',
  },
}

export const GET = ApiReference(config)

Or, if you just have a static OpenAPI spec, you can directly pass it as well:

const config = {
  spec: {
    content: '...',
  },
}

We wrote a detailed integration guide for Next.js.

The Next.js handler takes our universal configuration object, read more about configuration in the core package README.

Themes

By default, we’re using a custom Next.js theme and it’s beautiful. But you can choose one of our other themes, too:

const config = {
  theme: 'purple',
}

Pages router

If you are using the pages router, you can import the React component

npm install @scalar/api-reference-react
import { ApiReferenceReact } from '@scalar/api-reference-react'
import '@scalar/api-reference-react/style.css'

export default function References() {
  return (
    <ApiReferenceReact
      configuration={{
        spec: {
          url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.json',
        },
      }}
    />
  )
}

Specific CDN version

By default, this integration will use the latest version of the @scalar/api-reference.

You can also pin the CDN to a specific version by specifying it in the CDN string like https://cdn.jsdelivr.net/npm/@scalar/api-reference@1.25.28

You can find all available CDN versions here

// app/reference/route.ts
import { ApiReference } from '@scalar/nextjs-api-reference'

const config = {
  spec: {
    url: '/openapi.json',
  },
  cdn: 'https://cdn.jsdelivr.net/npm/@scalar/api-reference@latest',
}

export const GET = ApiReference(config)
apidocumentationnext.jsnextjsopenapiswagger
@scalar/types
@scalar/nextjs-openapi
0.4.98

12 months ago

0.4.97

12 months ago

0.4.96

1 year ago

0.4.95

1 year ago

0.4.93

1 year ago

0.4.94

1 year ago

0.4.91

1 year ago

0.4.92

1 year ago

0.4.90

1 year ago

0.4.87

1 year ago

0.4.88

1 year ago

0.4.89

1 year ago

0.4.86

1 year ago

0.4.85

1 year ago

0.4.84

1 year ago

0.4.42

1 year ago

0.4.43

1 year ago

0.4.40

1 year ago

0.4.41

1 year ago

0.4.48

1 year ago

0.4.49

1 year ago

0.4.46

1 year ago

0.4.47

1 year ago

0.4.44

1 year ago

0.4.31

1 year ago

0.4.32

1 year ago

0.3.62

1 year ago

0.3.61

1 year ago

0.3.60

1 year ago

0.4.39

1 year ago

0.4.37

1 year ago

0.4.38

1 year ago

0.4.35

1 year ago

0.4.36

1 year ago

0.4.33

1 year ago

0.4.34

1 year ago

0.3.53

1 year ago

0.4.21

1 year ago

0.3.52

1 year ago

0.3.51

1 year ago

0.3.50

1 year ago

0.4.28

1 year ago

0.4.29

1 year ago

0.4.26

1 year ago

0.3.59

1 year ago

0.4.27

1 year ago

0.3.58

1 year ago

0.4.24

1 year ago

0.3.57

1 year ago

0.4.25

1 year ago

0.3.56

1 year ago

0.4.22

1 year ago

0.3.55

1 year ago

0.4.23

1 year ago

0.3.54

1 year ago

0.4.19

1 year ago

0.4.10

1 year ago

0.4.17

1 year ago

0.4.18

1 year ago

0.3.49

1 year ago

0.4.15

1 year ago

0.3.48

1 year ago

0.3.47

1 year ago

0.4.13

1 year ago

0.3.46

1 year ago

0.4.14

1 year ago

0.3.45

1 year ago

0.4.11

1 year ago

0.3.44

1 year ago

0.4.82

1 year ago

0.4.83

1 year ago

0.4.80

1 year ago

0.4.81

1 year ago

0.4.75

1 year ago

0.4.76

1 year ago

0.4.73

1 year ago

0.4.74

1 year ago

0.4.71

1 year ago

0.4.72

1 year ago

0.4.70

1 year ago

0.4.79

1 year ago

0.4.77

1 year ago

0.4.78

1 year ago

0.4.64

1 year ago

0.4.65

1 year ago

0.4.62

1 year ago

0.4.63

1 year ago

0.4.60

1 year ago

0.4.61

1 year ago

0.4.68

1 year ago

0.4.69

1 year ago

0.4.66

1 year ago

0.4.67

1 year ago

0.4.53

1 year ago

0.4.54

1 year ago

0.4.51

1 year ago

0.4.52

1 year ago

0.4.50

1 year ago

0.4.59

1 year ago

0.4.57

1 year ago

0.4.58

1 year ago

0.4.55

1 year ago

0.4.56

1 year ago

0.4.9

1 year ago

0.4.8

1 year ago

0.4.5

1 year ago

0.4.4

1 year ago

0.4.6

1 year ago

0.4.1

1 year ago

0.4.0

1 year ago

0.4.3

1 year ago

0.4.2

1 year ago

0.3.42

1 year ago

0.3.43

1 year ago

0.3.41

1 year ago

0.3.40

1 year ago

0.3.39

1 year ago

0.3.38

1 year ago

0.3.37

1 year ago

0.3.36

1 year ago

0.3.35

1 year ago

0.3.34

1 year ago

0.3.33

1 year ago

0.3.32

1 year ago

0.3.31

1 year ago

0.3.30

1 year ago

0.3.29

1 year ago

0.3.28

1 year ago

0.3.27

1 year ago

0.3.26

1 year ago

0.3.25

1 year ago

0.3.24

1 year ago

0.3.20

1 year ago

0.3.19

1 year ago

0.3.18

1 year ago

0.3.17

1 year ago

0.3.16

1 year ago

0.3.15

1 year ago

0.3.14

1 year ago

0.3.13

1 year ago

0.3.12

1 year ago

0.3.11

1 year ago

0.3.10

1 year ago

0.3.8

1 year ago

0.3.7

1 year ago

0.3.9

1 year ago

0.3.6

1 year ago

0.3.5

1 year ago

0.3.4

1 year ago

0.3.0

2 years ago

0.3.2

2 years ago

0.3.1

2 years ago

0.3.3

2 years ago

0.2.41

2 years ago

0.2.40

2 years ago

0.2.39

2 years ago

0.2.38

2 years ago

0.2.37

2 years ago

0.2.36

2 years ago

0.2.35

2 years ago

0.2.34

2 years ago

0.2.33

2 years ago

0.2.32

2 years ago

0.2.30

2 years ago

0.2.31

2 years ago

0.2.29

2 years ago

0.2.28

2 years ago

0.2.27

2 years ago

0.2.26

2 years ago

0.2.25

2 years ago

0.2.24

2 years ago

0.2.23

2 years ago

0.2.22

2 years ago

0.2.21

2 years ago

0.2.20

2 years ago

0.2.19

2 years ago

0.2.18

2 years ago

0.2.17

2 years ago

0.2.16

2 years ago

0.2.15

2 years ago

0.2.13

2 years ago

0.2.12

2 years ago

0.2.11

2 years ago

0.2.10

2 years ago

0.2.9

2 years ago

0.2.8

2 years ago

0.2.7

2 years ago

0.2.6

2 years ago

0.2.5

2 years ago

0.2.4

2 years ago

0.2.1

2 years ago

0.2.3

2 years ago

0.2.2

2 years ago

0.1.51

2 years ago

0.1.50

2 years ago

0.1.48

2 years ago

0.1.46

2 years ago

0.1.47

2 years ago

0.1.45

2 years ago

0.1.44

2 years ago

0.1.43

2 years ago

0.1.41

2 years ago

0.1.42

2 years ago

0.1.40

2 years ago

0.1.39

2 years ago

0.1.34

2 years ago

0.1.35

2 years ago

0.1.36

2 years ago

0.1.37

2 years ago

0.1.38

2 years ago

0.1.30

2 years ago

0.1.31

2 years ago

0.1.32

2 years ago

0.1.33

2 years ago

0.1.29

2 years ago

0.1.28

2 years ago

0.1.27

2 years ago

0.1.25

2 years ago

0.1.26

2 years ago

0.1.24

2 years ago

0.1.20

2 years ago

0.1.21

2 years ago

0.1.22

2 years ago

0.1.23

2 years ago

0.1.18

2 years ago

0.1.19

2 years ago

0.1.17

2 years ago

0.1.15

2 years ago

0.1.16

2 years ago

0.1.14

2 years ago

0.1.12

2 years ago

0.1.13

2 years ago

0.1.11

2 years ago

0.1.10

2 years ago

0.1.7

2 years ago

0.1.9

2 years ago

0.1.6

2 years ago

0.1.5

2 years ago

0.1.4

2 years ago

0.1.3

2 years ago

0.1.1

2 years ago

0.1.0

2 years ago