1.25.56 • Published 2 months ago

@scalar/fastify-api-reference v1.25.56

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

Scalar for Fastify

Version Downloads License Discord

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

Screenshot of an API Reference

Installation

npm install @scalar/fastify-api-reference

And then register it with Fastify:

await fastify.register(require('@scalar/fastify-api-reference'), {
  routePrefix: '/reference',
})

Usage

If you have a OpenAPI/Swagger file already, you can pass an URL to the plugin:

// Render an API reference for a given OpenAPI/Swagger spec URL
fastify.register(require('@scalar/fastify-api-reference'), {
  routePrefix: '/reference',
  configuration: {
    title: 'Our API Reference',
    spec: {
      url: '/openapi.json',
    },
  },
})

With @fastify/swagger, we’re picking it up automatically, so this would be enough:

await fastify.register(require('@scalar/fastify-api-reference'), {
  routePrefix: '/reference',
})

We wrote a detailed integration guide for Fastify.

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

Themes

By default, we’re using a custom Fastify theme and it’s beautiful. But you can choose one of our other themes, too:

await fastify.register(require('@scalar/fastify-api-reference'), {
  routePrefix: '/reference',
  configuration: {
    theme: 'purple',
  },
})

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.

1.25.55

2 months ago

1.25.56

2 months ago

1.25.53

2 months ago

1.25.54

2 months ago

1.25.51

2 months ago

1.25.52

2 months ago

1.25.50

2 months ago

1.25.49

2 months ago

1.25.48

2 months ago

1.25.47

2 months ago

1.25.46

2 months ago

1.25.44

2 months ago

1.25.45

2 months ago

1.25.42

2 months ago

1.25.43

2 months ago

1.25.40

2 months ago

1.25.41

2 months ago

1.25.39

2 months ago

1.25.38

2 months ago

1.25.37

2 months ago

1.25.28

3 months ago

1.25.29

3 months ago

1.25.26

3 months ago

1.25.27

3 months ago

1.25.24

3 months ago

1.25.25

3 months ago

1.25.22

3 months ago

1.25.23

3 months ago

1.25.20

3 months ago

1.25.21

3 months ago

1.25.35

2 months ago

1.25.36

2 months ago

1.25.33

2 months ago

1.25.34

2 months ago

1.25.31

3 months ago

1.25.32

3 months ago

1.25.30

3 months ago

1.25.19

3 months ago

1.25.17

3 months ago

1.25.18

3 months ago

1.25.16

3 months ago

1.25.13

3 months ago

1.25.14

3 months ago

1.25.12

3 months ago

1.25.11

3 months ago

1.25.10

4 months ago

1.25.9

4 months ago

1.22.49

7 months ago

1.22.48

7 months ago

1.22.47

7 months ago

1.22.46

7 months ago

1.22.45

7 months ago

1.22.44

7 months ago

1.24.76

4 months ago

1.24.77

4 months ago

1.24.74

4 months ago

1.24.75

4 months ago

1.24.72

5 months ago

1.24.73

5 months ago

1.24.70

5 months ago

1.24.71

5 months ago

1.23.2

7 months ago

1.23.3

7 months ago

1.23.0

7 months ago

1.23.1

7 months ago

1.23.4

7 months ago

1.23.5

7 months ago

1.24.0

6 months ago

1.24.5

6 months ago

1.24.6

6 months ago

1.24.3

6 months ago

1.24.4

6 months ago

1.24.7

6 months ago

1.24.8

6 months ago

1.24.38

6 months ago

1.24.39

6 months ago

1.24.36

6 months ago

1.24.37

6 months ago

1.24.34

6 months ago

1.24.35

6 months ago

1.24.33

6 months ago

1.24.30

6 months ago

1.24.31

6 months ago

1.25.0

4 months ago

1.25.1

4 months ago

1.24.49

5 months ago

1.25.4

4 months ago

1.25.5

4 months ago

1.24.48

5 months ago

1.25.2

4 months ago

1.24.45

5 months ago

1.25.3

4 months ago

1.24.46

5 months ago

1.25.6

4 months ago

1.25.7

4 months ago

1.24.43

5 months ago

1.24.44

5 months ago

1.24.41

5 months ago

1.24.42

5 months ago

1.24.40

6 months ago

1.24.58

5 months ago

1.24.59

5 months ago

1.24.56

5 months ago

1.24.57

5 months ago

1.24.54

5 months ago

1.24.55

5 months ago

1.24.52

5 months ago

1.24.53

5 months ago

1.24.50

5 months ago

1.24.51

5 months ago

1.24.69

5 months ago

1.24.67

5 months ago

1.24.68

5 months ago

1.24.65

5 months ago

1.24.66

5 months ago

1.24.63

5 months ago

1.24.64

5 months ago

1.24.61

5 months ago

1.24.62

5 months ago

1.24.60

5 months ago

1.22.56

7 months ago

1.22.55

7 months ago

1.22.54

7 months ago

1.22.53

7 months ago

1.22.52

7 months ago

1.22.51

7 months ago

1.22.50

7 months ago

1.24.19

6 months ago

1.24.16

6 months ago

1.24.17

6 months ago

1.24.15

6 months ago

1.24.12

6 months ago

1.24.13

6 months ago

1.24.10

6 months ago

1.24.11

6 months ago

1.24.29

6 months ago

1.24.27

6 months ago

1.24.28

6 months ago

1.24.25

6 months ago

1.24.26

6 months ago

1.24.23

6 months ago

1.24.24

6 months ago

1.24.21

6 months ago

1.24.20

6 months ago

1.22.43

7 months ago

1.22.42

7 months ago

1.22.39

7 months ago

1.22.41

7 months ago

1.22.40

7 months ago

1.22.38

7 months ago

1.22.37

7 months ago

1.22.36

7 months ago

1.22.35

7 months ago

1.22.34

7 months ago

1.22.33

8 months ago

1.22.32

8 months ago

1.22.31

8 months ago

1.22.29

8 months ago

1.22.30

8 months ago

1.22.28

8 months ago

1.22.27

8 months ago

1.22.26

8 months ago

1.22.25

8 months ago

1.22.24

8 months ago

1.22.20

8 months ago

1.22.3

8 months ago

1.22.2

8 months ago

1.22.0

8 months ago

1.21.0

8 months ago

1.20.27

9 months ago

1.20.26

9 months ago

1.20.25

9 months ago

1.20.22

9 months ago

1.20.19

9 months ago

1.20.20

9 months ago

1.20.10

9 months ago

1.20.9

9 months ago

1.20.2

9 months ago

1.20.5

9 months ago

1.19.4

9 months ago

1.19.5

9 months ago

1.19.3

10 months ago

1.19.2

10 months ago

1.19.1

10 months ago

1.18.7

10 months ago

1.18.5

10 months ago

1.18.2

10 months ago

1.17.15

10 months ago

1.17.14

10 months ago

1.17.13

10 months ago

1.17.12

10 months ago

1.17.6

10 months ago

1.17.5

10 months ago

1.17.2

10 months ago

1.17.3

10 months ago

1.16.0

10 months ago

1.15.5

11 months ago

1.14.8

11 months ago

1.13.18

11 months ago

1.13.13

11 months ago

1.13.10

11 months ago

1.13.8

11 months ago

1.13.6

11 months ago

1.13.2

11 months ago

1.13.1

11 months ago

1.13.5

11 months ago

1.13.0

12 months ago

1.12.9

12 months ago

1.12.8

12 months ago

1.12.7

1 year ago

1.12.6

1 year ago

1.12.5

1 year ago

1.12.3

1 year ago

1.12.2

1 year ago

1.12.4

1 year ago

1.11.1

1 year ago

1.11.0

1 year ago

1.10.2

1 year ago

1.10.1

1 year ago

1.9.2

1 year ago

0.8.8

1 year ago

0.8.7

1 year ago

0.8.5

1 year ago

0.8.6

1 year ago

0.8.4

1 year ago

0.8.1

1 year ago

0.8.3

1 year ago

0.8.2

1 year ago

0.8.0

1 year ago

0.7.4

1 year ago

0.7.3

1 year ago

0.7.2

1 year ago

0.7.1

1 year ago

0.7.0

1 year ago

0.6.68

1 year ago

0.6.67

1 year ago

0.6.66

1 year ago

0.6.65

1 year ago

0.6.64

1 year ago

0.6.63

1 year ago

0.6.62

1 year ago

0.6.61

1 year ago

0.6.60

1 year ago

0.6.59

1 year ago

0.6.58

1 year ago

0.6.57

1 year ago

0.6.56

1 year ago

0.6.55

1 year ago

0.6.54

1 year ago

0.6.53

1 year ago

0.6.52

1 year ago

0.6.51

1 year ago

0.6.50

1 year ago

0.6.49

1 year ago

0.6.48

1 year ago

0.6.47

1 year ago

0.6.46

1 year ago

0.6.45

1 year ago

0.6.44

1 year ago

0.6.43

1 year ago

0.6.42

1 year ago

0.6.41

1 year ago

0.6.40

1 year ago

0.6.39

1 year ago

0.6.38

1 year ago

0.6.37

1 year ago

0.6.36

1 year ago

0.6.35

1 year ago

0.6.34

1 year ago

0.6.33

1 year ago

0.6.32

1 year ago

0.6.31

1 year ago

0.6.30

1 year ago

0.6.29

1 year ago

0.6.28

1 year ago

0.6.27

1 year ago

0.6.26

1 year ago

0.6.25

1 year ago

0.6.24

1 year ago

0.6.23

1 year ago

0.6.22

1 year ago

0.6.21

1 year ago

0.6.20

1 year ago

0.6.19

1 year ago

0.6.18

1 year ago

0.6.17

1 year ago

0.6.16

1 year ago

0.6.15

1 year ago

0.6.14

1 year ago

0.6.13

1 year ago

0.6.12

1 year ago

0.6.11

1 year ago

0.6.8

1 year ago

0.6.7

1 year ago

0.6.6

1 year ago

0.6.5

1 year ago

0.6.4

1 year ago

0.6.3

1 year ago

0.6.2

1 year ago

0.6.1

1 year ago

0.6.0

1 year ago

0.5.0

1 year ago

0.4.2

1 year ago

0.4.1

1 year ago

0.4.0

1 year ago

0.3.2

1 year ago

0.3.1

1 year ago

0.3.0

1 year ago

0.2.0

1 year ago