0.8.3 • Published 11 months ago

@scalar/express-api-reference v0.8.3

Weekly downloads
-
License
MIT
Repository
github
Last release
11 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 OpenAPI document? 🤔 There are multiple ways to generate an OpenAPI file for Express. The most popular way is to use swagger-jsdoc.

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

app.use(
  '/reference',
  apiReference({
    // 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',
    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',
    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/core
@everything-registry/sub-chunk-810express-zod-oasarx-cli@suegoidkun/siriuswebcreative-api-types@forklaunch/express@forklaunch/hyper-express@rapid-api/rapid-ts
0.7.2

1 year ago

0.7.1

1 year ago

0.7.4

1 year ago

0.7.3

1 year ago

0.7.0

1 year ago

0.4.193

1 year ago

0.4.192

1 year ago

0.4.190

1 year ago

0.8.1

12 months ago

0.8.3

11 months ago

0.8.2

11 months ago

0.6.7

1 year ago

0.6.6

1 year ago

0.6.9

1 year ago

0.6.8

1 year ago

0.5.0

1 year ago

0.7.6

12 months ago

0.7.5

12 months ago

0.6.3

1 year ago

0.6.2

1 year ago

0.6.5

1 year ago

0.6.4

1 year ago

0.6.1

1 year ago

0.6.0

1 year ago

0.4.182

1 year ago

0.4.181

1 year ago

0.4.180

1 year ago

0.4.186

1 year ago

0.4.185

1 year ago

0.4.184

1 year ago

0.4.183

1 year ago

0.4.189

1 year ago

0.4.188

1 year ago

0.4.187

1 year ago

0.4.171

1 year ago

0.4.170

1 year ago

0.4.175

1 year ago

0.4.174

1 year ago

0.4.173

1 year ago

0.4.172

1 year ago

0.4.179

1 year ago

0.4.178

1 year ago

0.4.177

1 year ago

0.4.176

1 year ago

0.4.168

1 year ago

0.4.167

1 year ago

0.4.169

1 year ago

0.4.166

2 years ago

0.4.165

2 years ago

0.4.164

2 years ago

0.4.163

2 years ago

0.4.160

2 years ago

0.4.162

2 years ago

0.4.161

2 years ago

0.4.159

2 years ago

0.4.153

2 years ago

0.4.152

2 years ago

0.4.151

2 years ago

0.4.157

2 years ago

0.4.156

2 years ago

0.4.155

2 years ago

0.4.158

2 years ago

0.4.149

2 years ago

0.4.150

2 years ago

0.4.148

2 years ago

0.4.48

2 years ago

0.4.49

2 years ago

0.4.46

2 years ago

0.4.47

2 years ago

0.4.44

2 years ago

0.4.45

2 years ago

0.4.86

2 years ago

0.4.87

2 years ago

0.4.84

2 years ago

0.4.85

2 years ago

0.4.82

2 years ago

0.4.80

2 years ago

0.4.81

2 years ago

0.4.88

2 years ago

0.4.89

2 years ago

0.4.102

2 years ago

0.4.101

2 years ago

0.4.100

2 years ago

0.4.106

2 years ago

0.4.105

2 years ago

0.4.104

2 years ago

0.4.103

2 years ago

0.4.76

2 years ago

0.4.73

2 years ago

0.4.74

2 years ago

0.4.71

2 years ago

0.4.72

2 years ago

0.4.77

2 years ago

0.4.78

2 years ago

0.4.64

2 years ago

0.4.65

2 years ago

0.4.62

2 years ago

0.4.63

2 years ago

0.4.60

2 years ago

0.4.61

2 years ago

0.4.68

2 years ago

0.4.69

2 years ago

0.4.66

2 years ago

0.4.67

2 years ago

0.4.53

2 years ago

0.4.54

2 years ago

0.4.51

2 years ago

0.4.52

2 years ago

0.4.50

2 years ago

0.4.59

2 years ago

0.4.57

2 years ago

0.4.58

2 years ago

0.4.55

2 years ago

0.4.56

2 years ago

0.4.142

2 years ago

0.4.141

2 years ago

0.4.140

2 years ago

0.4.146

2 years ago

0.4.145

2 years ago

0.4.144

2 years ago

0.4.143

2 years ago

0.4.129

2 years ago

0.4.131

2 years ago

0.4.130

2 years ago

0.4.135

2 years ago

0.4.134

2 years ago

0.4.133

2 years ago

0.4.132

2 years ago

0.4.139

2 years ago

0.4.138

2 years ago

0.4.137

2 years ago

0.4.136

2 years ago

0.4.119

2 years ago

0.4.118

2 years ago

0.4.120

2 years ago

0.4.124

2 years ago

0.4.123

2 years ago

0.4.122

2 years ago

0.4.121

2 years ago

0.4.128

2 years ago

0.4.127

2 years ago

0.4.126

2 years ago

0.4.125

2 years ago

0.4.97

2 years ago

0.4.109

2 years ago

0.4.98

2 years ago

0.4.95

2 years ago

0.4.107

2 years ago

0.4.96

2 years ago

0.4.94

2 years ago

0.4.91

2 years ago

0.4.92

2 years ago

0.4.99

2 years ago

0.4.113

2 years ago

0.4.112

2 years ago

0.4.90

2 years ago

0.4.111

2 years ago

0.4.110

2 years ago

0.4.117

2 years ago

0.4.116

2 years ago

0.4.115

2 years ago

0.4.114

2 years ago

0.4.42

2 years ago

0.4.43

2 years ago

0.4.40

2 years ago

0.4.41

2 years ago

0.4.39

2 years ago

0.4.38

2 years ago

0.4.37

2 years ago

0.4.36

2 years ago

0.4.35

2 years ago

0.4.34

2 years ago

0.4.33

2 years ago

0.4.32

2 years ago

0.4.31

2 years ago

0.4.30

2 years ago

0.4.29

2 years ago

0.4.28

2 years ago

0.4.27

2 years ago

0.4.26

2 years ago

0.4.25

2 years ago

0.4.24

2 years ago

0.4.20

2 years ago

0.4.19

2 years ago

0.4.18

2 years ago

0.4.17

2 years ago

0.4.15

2 years ago

0.4.16

2 years ago

0.4.14

2 years ago

0.4.13

2 years ago

0.4.11

2 years ago

0.4.12

2 years ago

0.4.10

2 years ago

0.4.9

2 years ago

0.4.8

2 years ago

0.4.7

2 years ago

0.4.5

2 years ago

0.4.4

2 years ago

0.4.6

2 years ago

0.4.1

2 years ago

0.4.0

2 years ago

0.4.3

2 years ago

0.4.2

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

2 years ago

0.3.22

2 years ago

0.3.21

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

2 years ago

0.3.12

2 years ago

0.3.11

2 years ago

0.3.10

2 years ago

0.3.9

2 years ago

0.3.8

2 years ago

0.3.7

2 years ago

0.3.6

2 years ago

0.3.5

2 years ago

0.3.4

2 years ago

0.3.2

2 years ago

0.3.1

2 years ago

0.3.3

2 years ago

0.2.75

2 years ago

0.2.74

2 years ago

0.2.72

2 years ago

0.2.71

2 years ago

0.2.70

2 years ago

0.2.69

2 years ago

0.2.68

2 years ago

0.2.67

2 years ago

0.2.66

2 years ago

0.2.65

2 years ago

0.2.64

2 years ago

0.2.63

2 years ago

0.2.62

2 years ago

0.2.61

2 years ago

0.2.60

2 years ago

0.2.59

2 years ago

0.2.58

2 years ago

0.2.57

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