0.5.158 • Published 9 months ago

@scalar/hono-api-reference v0.5.158

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

Scalar for Hono

Version Downloads License Discord

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

hono-js

Installation

npm install @scalar/hono-api-reference

Usage

Set up Zod OpenAPI Hono and pass the configured URL to the apiReference middleware:

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

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

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

Themes

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

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

Custom page title

There’s one additional option to set the page title:

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

app.get(
  '/reference',
  apiReference({
    pageTitle: 'Hono API Reference',
    spec: {
      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/hono-api-reference'

app.use(
  '/reference',
  apiReference({
    cdn: 'https://cdn.jsdelivr.net/npm/@scalar/api-reference@latest',
    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-810@ladc.dev/hono-utilsrsshubrohi-consumet-apiprompt-manahono-with-drizzlegenii-server
0.5.158

9 months ago

0.5.157

9 months ago

0.5.156

9 months ago

0.5.155

10 months ago

0.5.154

10 months ago

0.5.149

10 months ago

0.5.150

10 months ago

0.5.152

10 months ago

0.5.151

10 months ago

0.5.153

10 months ago

0.5.147

10 months ago

0.5.148

10 months ago

0.5.146

11 months ago

0.5.145

11 months ago

0.5.144

11 months ago

0.5.103

1 year ago

0.5.102

1 year ago

0.5.105

1 year ago

0.5.104

1 year ago

0.5.101

1 year ago

0.5.100

1 year ago

0.5.54

1 year ago

0.5.55

1 year ago

0.5.130

12 months ago

0.5.52

1 year ago

0.5.53

1 year ago

0.5.50

1 year ago

0.5.51

1 year ago

0.5.136

12 months ago

0.5.135

12 months ago

0.5.138

12 months ago

0.5.137

12 months ago

0.5.132

12 months ago

0.5.58

1 year ago

0.5.131

12 months ago

0.5.59

1 year ago

0.5.134

12 months ago

0.5.56

1 year ago

0.5.133

12 months ago

0.5.57

1 year ago

0.5.129

12 months ago

0.5.128

12 months ago

0.5.44

1 year ago

0.5.141

12 months ago

0.5.140

12 months ago

0.5.49

1 year ago

0.5.143

11 months ago

0.5.47

1 year ago

0.5.142

11 months ago

0.5.48

1 year ago

0.5.45

1 year ago

0.5.46

1 year ago

0.5.139

12 months ago

0.5.114

1 year ago

0.5.113

1 year ago

0.5.116

1 year ago

0.5.115

1 year ago

0.5.110

1 year ago

0.5.112

1 year ago

0.5.111

1 year ago

0.5.107

1 year ago

0.5.106

1 year ago

0.5.109

1 year ago

0.5.125

12 months ago

0.5.124

12 months ago

0.5.127

12 months ago

0.5.126

12 months ago

0.5.121

1 year ago

0.5.120

1 year ago

0.5.123

12 months ago

0.5.122

1 year ago

0.5.118

1 year ago

0.5.117

1 year ago

0.5.119

1 year ago

0.5.98

1 year ago

0.5.99

1 year ago

0.5.96

1 year ago

0.5.97

1 year ago

0.5.94

1 year ago

0.5.95

1 year ago

0.5.92

1 year ago

0.5.90

1 year ago

0.5.91

1 year ago

0.5.87

1 year ago

0.5.88

1 year ago

0.5.85

1 year ago

0.5.86

1 year ago

0.5.84

1 year ago

0.5.81

1 year ago

0.5.82

1 year ago

0.5.89

1 year ago

0.5.80

1 year ago

0.5.76

1 year ago

0.5.77

1 year ago

0.5.74

1 year ago

0.5.72

1 year ago

0.5.73

1 year ago

0.5.71

1 year ago

0.5.78

1 year ago

0.5.65

1 year ago

0.5.66

1 year ago

0.5.63

1 year ago

0.5.64

1 year ago

0.5.61

1 year ago

0.5.62

1 year ago

0.5.60

1 year ago

0.5.69

1 year ago

0.5.67

1 year ago

0.5.68

1 year ago

0.5.43

1 year ago

0.5.42

1 year ago

0.5.41

1 year ago

0.5.40

1 year ago

0.5.39

1 year ago

0.5.38

1 year ago

0.5.36

1 year ago

0.5.37

1 year ago

0.5.34

1 year ago

0.5.35

1 year ago

0.5.33

1 year ago

0.5.32

1 year ago

0.5.31

1 year ago

0.5.30

1 year ago

0.5.29

1 year ago

0.5.27

1 year ago

0.5.28

1 year ago

0.5.25

1 year ago

0.5.26

1 year ago

0.5.24

1 year ago

0.5.20

1 year ago

0.5.19

1 year ago

0.5.18

1 year ago

0.5.17

1 year ago

0.5.16

1 year ago

0.5.14

1 year ago

0.5.15

1 year ago

0.5.11

1 year ago

0.5.12

1 year ago

0.5.13

1 year ago

0.5.10

1 year ago

0.5.8

1 year ago

0.5.7

1 year ago

0.5.9

1 year ago

0.5.4

1 year ago

0.5.6

1 year ago

0.5.5

1 year ago

0.5.3

1 year ago

0.5.0

1 year ago

0.5.2

1 year ago

0.5.1

1 year ago

0.4.40

1 year ago

0.4.41

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

1 year ago

0.4.29

1 year ago

0.4.26

1 year ago

0.4.27

1 year ago

0.4.24

1 year ago

0.4.25

1 year ago

0.4.23

1 year ago

0.4.22

1 year ago

0.4.21

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

1 year ago

0.4.15

1 year ago

0.4.10

1 year ago

0.4.13

1 year ago

0.4.11

1 year ago

0.4.12

1 year ago

0.4.9

1 year ago

0.4.8

1 year ago

0.4.7

1 year ago

0.4.6

1 year ago

0.4.5

1 year ago

0.4.4

1 year ago

0.4.1

1 year ago

0.4.3

1 year ago

0.4.2

1 year ago

0.3.75

1 year ago

0.3.74

1 year ago

0.3.72

1 year ago

0.3.71

1 year ago

0.3.70

1 year 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.64

1 year ago

0.3.63

1 year ago

0.3.62

1 year ago

0.3.61

1 year ago

0.3.60

1 year ago

0.3.59

1 year ago

0.3.58

1 year ago

0.3.57

1 year ago

0.3.56

1 year ago

0.3.55

1 year ago

0.3.54

1 year ago

0.3.53

1 year ago

0.3.52

1 year ago

0.3.51

1 year ago

0.3.50

1 year ago

0.3.49

1 year ago

0.3.48

1 year ago

0.3.47

1 year ago

0.3.46

1 year ago

0.3.45

1 year ago

0.3.44

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

2 years ago

0.3.2

2 years ago

0.3.1

2 years ago

0.3.0

2 years ago

0.2.11

2 years ago

0.2.10

2 years ago

0.2.8

2 years ago

0.2.7

2 years ago

0.2.6

2 years ago

0.2.3

2 years ago

0.2.5

2 years ago

0.2.4

2 years ago

0.2.2

2 years ago

0.2.0

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

2 years ago

0.1.17

2 years ago

0.1.16

2 years ago

0.1.15

2 years ago

0.1.14

2 years ago

0.1.13

2 years ago

0.1.12

2 years ago

0.1.11

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

2 years ago

0.1.3

2 years ago

0.1.2

2 years ago

0.1.0

2 years ago