0.4.166 • Published 8 months ago

@scalar/express-api-reference v0.4.166

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

Scalar Express 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 Express.

Installation

npm install @scalar/express-api-reference

Usage

Set up Express and pass an URL to an OpenAPI/Swagger document to the apiReference middleware:

Wait, but how do we get the OpenApiSpecification? 🤔 There are multiple ways to generate an OpenAPI/Swagger file for Express. The most popular way is to use swagger-jsdoc.

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

app.use(
  '/reference',
  apiReference({
    spec: {
      // Put your OpenAPI url here:
      url: '/openapi.json',
    },
  }),
)

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

Themes

The middleware comes with a custom theme for Express. 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/express-api-reference'

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

Custom CDN

You can use a custom CDN ，default is https://cdn.jsdelivr.net/npm/@scalar/api-reference.

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

app.use(
  '/reference',
  apiReference({
    cdn: 'https://cdn.jsdelivr.net/npm/@scalar/api-reference',
    spec: {
      url: '/openapi.json',
    },
  }),
)

Community

We are API nerds. You too? Let’s chat on Discord: https://discord.gg/scalar

License

The source code in this repository is licensed under MIT.

@scalar/types
@everything-registry/sub-chunk-810express-zod-oas@suegoidkun/siriuswebcreative-api-typesarx-cli
0.4.166

8 months ago

0.4.165

8 months ago

0.4.164

8 months ago

0.4.163

8 months ago

0.4.160

8 months ago

0.4.162

8 months ago

0.4.161

8 months ago

0.4.159

9 months ago

0.4.153

9 months ago

0.4.152

9 months ago

0.4.151

9 months ago

0.4.157

9 months ago

0.4.156

9 months ago

0.4.155

9 months ago

0.4.158

9 months ago

0.4.149

9 months ago

0.4.150

9 months ago

0.4.148

9 months 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.45

1 year ago

0.4.86

12 months ago

0.4.87

12 months ago

0.4.84

12 months ago

0.4.85

12 months ago

0.4.82

12 months ago

0.4.80

12 months ago

0.4.81

12 months ago

0.4.88

12 months ago

0.4.89

12 months ago

0.4.102

11 months ago

0.4.101

11 months ago

0.4.100

11 months ago

0.4.106

11 months ago

0.4.105

11 months ago

0.4.104

11 months ago

0.4.103

11 months ago

0.4.76

12 months ago

0.4.73

12 months ago

0.4.74

12 months ago

0.4.71

12 months ago

0.4.72

12 months ago

0.4.77

12 months ago

0.4.78

12 months ago

0.4.64

12 months ago

0.4.65

12 months ago

0.4.62

1 year ago

0.4.63

12 months ago

0.4.60

1 year ago

0.4.61

1 year ago

0.4.68

12 months ago

0.4.69

12 months ago

0.4.66

12 months ago

0.4.67

12 months 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.142

10 months ago

0.4.141

10 months ago

0.4.140

10 months ago

0.4.146

10 months ago

0.4.145

10 months ago

0.4.144

10 months ago

0.4.143

10 months ago

0.4.129

11 months ago

0.4.131

10 months ago

0.4.130

10 months ago

0.4.135

10 months ago

0.4.134

10 months ago

0.4.133

10 months ago

0.4.132

10 months ago

0.4.139

10 months ago

0.4.138

10 months ago

0.4.137

10 months ago

0.4.136

10 months ago

0.4.119

11 months ago

0.4.118

11 months ago

0.4.120

11 months ago

0.4.124

11 months ago

0.4.123

11 months ago

0.4.122

11 months ago

0.4.121

11 months ago

0.4.128

11 months ago

0.4.127

11 months ago

0.4.126

11 months ago

0.4.125

11 months ago

0.4.97

11 months ago

0.4.109

11 months ago

0.4.98

11 months ago

0.4.95

11 months ago

0.4.107

11 months ago

0.4.96

11 months ago

0.4.94

11 months ago

0.4.91

12 months ago

0.4.92

12 months ago

0.4.99

11 months ago

0.4.113

11 months ago

0.4.112

11 months ago

0.4.90

12 months ago

0.4.111

11 months ago

0.4.110

11 months ago

0.4.117

11 months ago

0.4.116

11 months ago

0.4.115

11 months ago

0.4.114

11 months 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.39

1 year ago

0.4.38

1 year ago

0.4.37

1 year ago

0.4.36

1 year ago

0.4.35

1 year ago

0.4.34

1 year ago

0.4.33

1 year ago

0.4.32

1 year ago

0.4.31

1 year ago

0.4.30

1 year ago

0.4.29

1 year ago

0.4.28

1 year ago

0.4.27

1 year ago

0.4.26

1 year ago

0.4.25

1 year ago

0.4.24

1 year ago

0.4.20

1 year ago

0.4.19

1 year ago

0.4.18

1 year ago

0.4.17

1 year ago

0.4.15

1 year ago

0.4.16

1 year ago

0.4.14

1 year ago

0.4.13

1 year ago

0.4.11

1 year ago

0.4.12

1 year ago

0.4.10

1 year ago

0.4.9

1 year ago

0.4.8

1 year ago

0.4.7

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

1 year ago

0.3.22

1 year ago

0.3.21

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

1 year ago

0.3.12

1 year ago

0.3.11

1 year ago

0.3.10

1 year ago

0.3.9

1 year ago

0.3.8

1 year ago

0.3.7

1 year ago

0.3.6

1 year ago

0.3.5

1 year ago

0.3.4

1 year ago

0.3.2

1 year ago

0.3.1

1 year ago

0.3.3

1 year ago

0.2.75

1 year ago

0.2.74

1 year ago

0.2.72

1 year ago

0.2.71

1 year ago

0.2.70

1 year ago

0.2.69

1 year ago

0.2.68

1 year ago

0.2.67

1 year ago

0.2.66

1 year ago

0.2.65

1 year ago

0.2.64

1 year ago

0.2.63

1 year ago

0.2.62

1 year ago

0.2.61

1 year ago

0.2.60

1 year ago

0.2.59

1 year ago

0.2.58

1 year ago

0.2.57

1 year ago

0.2.56

1 year ago

0.2.55

1 year ago

0.2.54

1 year ago

0.2.53

1 year ago

0.2.52

1 year ago

0.2.51

1 year ago

0.2.50

1 year ago

0.2.49

1 year ago

0.2.48

1 year ago

0.2.47

1 year ago

0.2.46

1 year ago

0.2.45

1 year ago

0.2.44

1 year ago

0.2.43

1 year ago

0.2.42

1 year ago

0.2.41

1 year ago

0.2.40

1 year ago

0.2.39

1 year ago

0.2.38

1 year ago

0.2.37

1 year ago

0.2.36

1 year ago

0.2.35

1 year ago

0.2.34

1 year ago

0.2.32

1 year ago

0.2.30

1 year ago

0.2.31

1 year ago

0.2.29

1 year ago

0.2.28

1 year ago

0.2.26

1 year ago

0.2.25

1 year ago

0.2.24

1 year ago

0.2.23

1 year ago

0.2.22

1 year ago

0.2.21

1 year ago

0.2.20

1 year ago

0.2.19

1 year ago

0.2.18

1 year ago

0.2.17

1 year ago

0.2.16

1 year ago

0.2.15

1 year ago

0.2.14

1 year ago

0.2.13

1 year ago

0.2.12

1 year ago

0.2.11

1 year ago

0.2.10

1 year ago

0.2.9

1 year ago

0.2.8

1 year ago

0.2.7

1 year ago

0.2.6

1 year ago

0.2.5

1 year ago

0.2.4

1 year ago

0.2.3

1 year ago

0.2.2

1 year ago

0.2.1

1 year ago

0.2.0

1 year ago

0.1.10

2 years ago

0.1.11

2 years ago

0.1.8

2 years ago

0.1.7

2 years ago

0.1.6

2 years ago

0.1.4

2 years ago

0.1.3

2 years ago

0.1.5

2 years ago

0.1.2

2 years ago

0.1.0

2 years ago

0.0.15

2 years ago

0.0.14

2 years ago

0.0.13

2 years ago

0.0.12

2 years ago

0.0.11

2 years ago

0.0.10

2 years ago

0.0.9

2 years ago

0.0.8

2 years ago

0.0.7

2 years ago

0.0.6

2 years ago

0.0.5

2 years ago

0.0.4

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago