0.5.2 • Published 6 months ago

@scalar/nestjs-api-reference v0.5.2

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

Scalar NestJS API Reference Plugin

Version Downloads License Discord

This middleware provides an easy way to render a beautiful API reference based on an OpenAPI/Swagger file with NestJS.

Installation

npm install @scalar/nestjs-api-reference

Usage

Set up NestJS and set up NestJS Swagger and pass an OpenAPI/Swagger document to the apiReference middleware:

import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger'
import { apiReference } from '@scalar/nestjs-api-reference'

/* ... */
const app = await NestFactory.create(AppModule)

const config = new DocumentBuilder()
  .setTitle('Cats example')
  .setDescription('The cats API description')
  .setVersion('1.0')
  .addTag('cats')
  .build()

const document = SwaggerModule.createDocument(app, config)
/* ... */

const OpenApiSpecification =
  /* … */

  app.use(
    '/reference',
    apiReference({
      content: document,
    }),
  )

Recommended: If you’re serving an OpenAPI/Swagger file already, you can pass an URL, too:

import { apiReference } from '@scalar/nestjs-api-reference'

app.use(
  '/reference',
  apiReference({
    url: '/openapi.json',
  }),
)

The NestJS middleware takes our universal configuration object, read more about configuration in the core package README.

Themes

The middleware comes with a custom theme for NestJS. You can use one of the other predefined themes (alternate, default, moon, purple, solarized) or overwrite it with none. All themes come with a light and dark color scheme.

import { apiReference } from '@scalar/nestjs-api-reference'

app.use(
  '/reference',
  apiReference({
    theme: 'purple',
    url: '/openapi.json',
  }),
)

Custom CDN

You can use a custom CDN ，default is https://cdn.jsdelivr.net/npm/@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

import { apiReference } from '@scalar/nestjs-api-reference'

app.use(
  '/reference',
  apiReference({
    cdn: 'https://cdn.jsdelivr.net/npm/@scalar/api-reference@latest',
    content: OpenApiSpecification,
  }),
)
@scalar/types
@everything-registry/sub-chunk-810autosync_backend
0.3.181

10 months ago

0.3.180

10 months ago

0.3.183

10 months ago

0.3.182

10 months ago

0.3.185

9 months ago

0.3.184

10 months ago

0.3.187

9 months ago

0.3.186

9 months ago

0.3.189

9 months ago

0.3.170

1 year ago

0.3.172

1 year ago

0.3.171

1 year ago

0.3.174

12 months ago

0.3.173

12 months ago

0.3.176

11 months ago

0.3.175

11 months ago

0.3.178

10 months ago

0.3.177

11 months ago

0.3.179

10 months ago

0.3.169

1 year ago

0.3.168

1 year ago

0.4.10

8 months ago

0.4.15

7 months ago

0.4.16

7 months ago

0.4.13

7 months ago

0.4.14

7 months ago

0.4.11

8 months ago

0.4.12

7 months ago

0.5.2

6 months ago

0.5.1

7 months ago

0.3.190

9 months ago

0.4.9

8 months ago

0.4.8

8 months ago

0.4.5

8 months ago

0.4.4

8 months ago

0.4.7

8 months ago

0.4.6

8 months ago

0.4.1

9 months ago

0.4.0

9 months ago

0.4.3

9 months ago

0.4.2

9 months ago

0.3.167

1 year ago

0.3.166

1 year ago

0.3.165

1 year ago

0.3.164

1 year ago

0.3.161

1 year ago

0.3.160

1 year ago

0.3.163

1 year ago

0.3.162

1 year ago

0.3.159

1 year ago

0.3.152

1 year ago

0.3.151

1 year ago

0.3.153

1 year ago

0.3.156

1 year ago

0.3.155

1 year ago

0.3.158

1 year ago

0.3.157

1 year ago

0.3.150

1 year ago

0.3.149

1 year ago

0.3.148

1 year ago

0.3.74

1 year ago

0.3.73

1 year ago

0.3.72

1 year ago

0.3.71

1 year ago

0.3.78

1 year ago

0.3.77

1 year ago

0.3.76

1 year ago

0.3.64

1 year ago

0.3.63

1 year ago

0.3.62

2 years ago

0.3.61

2 years ago

0.3.60

2 years ago

0.3.69

1 year ago

0.3.68

1 year ago

0.3.67

1 year ago

0.3.66

1 year ago

0.3.65

1 year ago

0.3.53

2 years ago

0.3.52

2 years ago

0.3.51

2 years ago

0.3.50

2 years ago

0.3.59

2 years ago

0.3.58

2 years ago

0.3.57

2 years ago

0.3.56

2 years ago

0.3.55

2 years ago

0.3.54

2 years ago

0.3.49

2 years ago

0.3.48

2 years ago

0.3.47

2 years ago

0.3.46

2 years ago

0.3.45

2 years ago

0.3.44

2 years ago

0.3.97

1 year ago

0.3.96

1 year ago

0.3.95

1 year ago

0.3.94

1 year ago

0.3.92

1 year ago

0.3.91

1 year ago

0.3.90

1 year ago

0.3.99

1 year ago

0.3.98

1 year ago

0.3.86

1 year ago

0.3.85

1 year ago

0.3.84

1 year ago

0.3.82

1 year ago

0.3.81

1 year ago

0.3.80

1 year ago

0.3.89

1 year ago

0.3.88

1 year ago

0.3.87

1 year ago

0.3.101

1 year ago

0.3.100

1 year ago

0.3.103

1 year ago

0.3.102

1 year ago

0.3.105

1 year ago

0.3.104

1 year ago

0.3.107

1 year ago

0.3.106

1 year ago

0.3.141

1 year ago

0.3.140

1 year ago

0.3.143

1 year ago

0.3.142

1 year ago

0.3.145

1 year ago

0.3.144

1 year ago

0.3.146

1 year ago

0.3.130

1 year ago

0.3.132

1 year ago

0.3.131

1 year ago

0.3.134

1 year ago

0.3.133

1 year ago

0.3.136

1 year ago

0.3.135

1 year ago

0.3.138

1 year ago

0.3.137

1 year ago

0.3.139

1 year ago

0.3.121

1 year ago

0.3.120

1 year ago

0.3.123

1 year ago

0.3.122

1 year ago

0.3.125

1 year ago

0.3.124

1 year ago

0.3.127

1 year ago

0.3.126

1 year ago

0.3.129

1 year ago

0.3.128

1 year ago

0.3.119

1 year ago

0.3.110

1 year ago

0.3.112

1 year ago

0.3.111

1 year ago

0.3.114

1 year ago

0.3.113

1 year ago

0.3.116

1 year ago

0.3.115

1 year ago

0.3.118

1 year ago

0.3.117

1 year ago

0.3.109

1 year ago

0.3.42

2 years ago

0.3.43

2 years ago

0.3.41

2 years ago

0.3.40

2 years ago

0.3.39

2 years ago

0.3.38

2 years ago

0.3.37

2 years ago

0.3.36

2 years ago

0.3.35

2 years ago

0.3.34

2 years ago

0.3.33

2 years ago

0.3.32

2 years ago

0.3.31

2 years ago

0.3.30

2 years ago

0.3.29

2 years ago

0.3.28

2 years ago

0.3.27

2 years ago

0.3.26

2 years ago

0.3.25

2 years ago

0.3.24

2 years ago

0.3.20

2 years ago

0.3.19

2 years ago

0.3.18

2 years ago

0.3.17

2 years ago

0.3.16

2 years ago

0.3.15

2 years ago

0.3.14

2 years ago

0.3.13

2 years ago

0.3.12

2 years ago

0.3.11

2 years ago

0.3.10

2 years ago

0.3.8

2 years ago

0.3.7

2 years ago

0.3.9

2 years ago

0.3.6

2 years ago

0.3.5

2 years ago

0.3.4

2 years 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.74

2 years ago

0.1.73

2 years ago

0.1.71

2 years ago

0.1.70

2 years ago

0.1.69

2 years ago

0.1.68

2 years ago

0.1.67

2 years ago

0.1.66

2 years ago

0.1.64

2 years ago

0.1.65

2 years ago

0.1.63

2 years ago

0.1.62

2 years ago

0.1.57

2 years ago

0.1.58

2 years ago

0.1.59

2 years ago

0.1.60

2 years ago

0.1.61

2 years ago

0.1.53

2 years ago

0.1.54

2 years ago

0.1.55

2 years ago

0.1.56

2 years ago

0.1.52

2 years ago

0.1.51

2 years ago

0.1.50

2 years ago

0.1.49

2 years ago

0.1.48

2 years ago

0.1.47

2 years ago

0.1.43

2 years ago

0.1.44

2 years ago

0.1.45

2 years ago

0.1.46

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.38

2 years ago

0.1.36

2 years ago

0.1.37

2 years ago

0.1.35

2 years ago

0.1.31

2 years ago

0.1.33

2 years ago

0.1.34

2 years ago

0.1.30

2 years ago

0.1.29

2 years ago

0.1.27

2 years ago

0.1.28

2 years ago

0.1.25

2 years ago

0.1.23

2 years ago

0.1.24

2 years ago

0.1.22

2 years ago

0.1.21

2 years ago

0.1.20

2 years ago

0.1.19

2 years ago

0.1.17

2 years ago

0.1.18

2 years ago

0.1.11

2 years ago

0.1.12

2 years ago

0.1.13

2 years ago

0.1.14

2 years ago

0.1.15

2 years ago

0.1.16

2 years ago

0.1.10

2 years ago

0.1.9

2 years ago

0.1.8

2 years ago

0.1.7

2 years ago

0.1.6

2 years ago

0.1.5

2 years ago

0.1.2

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