0.4.166 • Published 10 months ago

@scalar/express-api-reference v0.4.166

Weekly downloads
-
License
MIT
Repository
github
Last release
10 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-oasarx-cli@suegoidkun/siriuswebcreative-api-types
0.4.166

10 months ago

0.4.165

10 months ago

0.4.164

10 months ago

0.4.163

10 months ago

0.4.160

11 months ago

0.4.162

11 months ago

0.4.161

11 months ago

0.4.159

11 months ago

0.4.153

11 months ago

0.4.152

11 months ago

0.4.151

11 months ago

0.4.157

11 months ago

0.4.156

11 months ago

0.4.155

11 months ago

0.4.158

11 months ago

0.4.149

12 months ago

0.4.150

11 months ago

0.4.148

12 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

1 year ago

0.4.87

1 year ago

0.4.84

1 year ago

0.4.85

1 year ago

0.4.82

1 year ago

0.4.80

1 year ago

0.4.81

1 year ago

0.4.88

1 year ago

0.4.89

1 year ago

0.4.102

1 year ago

0.4.101

1 year ago

0.4.100

1 year ago

0.4.106

1 year ago

0.4.105

1 year ago

0.4.104

1 year ago

0.4.103

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

1 year ago

0.4.141

1 year ago

0.4.140

1 year ago

0.4.146

12 months ago

0.4.145

12 months ago

0.4.144

1 year ago

0.4.143

1 year ago

0.4.129

1 year ago

0.4.131

1 year ago

0.4.130

1 year ago

0.4.135

1 year ago

0.4.134

1 year ago

0.4.133

1 year ago

0.4.132

1 year ago

0.4.139

1 year ago

0.4.138

1 year ago

0.4.137

1 year ago

0.4.136

1 year ago

0.4.119

1 year ago

0.4.118

1 year ago

0.4.120

1 year ago

0.4.124

1 year ago

0.4.123

1 year ago

0.4.122

1 year ago

0.4.121

1 year ago

0.4.128

1 year ago

0.4.127

1 year ago

0.4.126

1 year ago

0.4.125

1 year ago

0.4.97

1 year ago

0.4.109

1 year ago

0.4.98

1 year ago

0.4.95

1 year ago

0.4.107

1 year ago

0.4.96

1 year ago

0.4.94

1 year ago

0.4.91

1 year ago

0.4.92

1 year ago

0.4.99

1 year ago

0.4.113

1 year ago

0.4.112

1 year ago

0.4.90

1 year ago

0.4.111

1 year ago

0.4.110

1 year ago

0.4.117

1 year ago

0.4.116

1 year ago

0.4.115

1 year ago

0.4.114

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

2 years ago

0.2.55

2 years ago

0.2.54

2 years ago

0.2.53

2 years ago

0.2.52

2 years ago

0.2.51

2 years ago

0.2.50

2 years ago

0.2.49

2 years ago

0.2.48

2 years ago

0.2.47

2 years ago

0.2.46

2 years ago

0.2.45

2 years ago

0.2.44

2 years ago

0.2.43

2 years ago

0.2.42

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

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

2 years ago

0.2.2

2 years ago

0.2.1

2 years ago

0.2.0

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