0.13.4 • Published 8 months ago

zudoku v0.13.4

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

MIT License Zudoku Version Create Zudoku App Version Made with love by Zuplo

Zudoku

API documentation should always be free.

Installation · Docs · Examples · Contributing · Motivation

Introduction

Zudoku (pronounced "zoo-doh-koo") is an open-source, highly customizable API documentation framework for building quality developer experiences around OpenAPI and, soon, GraphQL documents.

Because great API documentation frameworks should be:

🌍 Free & Open Source ✅ OpenAPI powered 🔩 Extensible with Plugins ⚡ Easy to setup & blazing fast to work with 🔧 Easy to maintain

🤩 Try it, right now!

You can test Zudoku with your own OpenAPI document at zudoku.dev and see how good your documentation can look!

✨ Features

  • 🚀 Generate documentation from a single or multiple OpenAPI schema
  • 📄 Create MDX pages for anything you want to document
  • 🔐 Integrate your users with authentication via OpenID or OAuth2
  • 🧪 Let users test their API calls using the Integrated Playground (includes authentication!)
  • 🌑 Dark mode (of course!)

Zudoku is quick to implement, easy to configure and is highly composable with sensible defaults.

⚙️ Installation

You can use the CLI to generate a new project or use it standalone via CDN as a React component.

⚡️ Quick start

Fire up your new API docs using the command line generator:

npm create zudoku-app@latest

📦 Standalone via CDN

Add the package and styles to your <head> and pass the URL for your API schema to the data-api-url property, as shown here:

<!doctype html>
<html>
  <head>
    <title>Zudoku Demo</title>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />

    <link rel="icon" type="image/svg+xml" href="https://cdn.zudoku.dev/logos/favicon.svg" />
    <script type="module" src="https://cdn.zudoku.dev/latest/main.js" crossorigin></script>
    <link rel="stylesheet" href="https://cdn.zudoku.dev/latest/style.css" crossorigin />
  </head>
  <body>
    <div data-api-url="https://api.example.com/openapi.json"></div>
  </body>
</html>

🧱 Getting started templates

To get started with some of the features Zudoku offers you can use one of these example templates:

TemplateWhat it does
many-apisUsing more than one OpenAPI document with Zudoku
with-auth0Authenticate users in docs with the Auth0 plugin
with-configBarebones config, ready for you to setup how you like
with-vite-configUse Zudoku with your Vite config (Advanced)

🎓 Examples

Zudoku use cases

Zudoku is a flexible and highly customizable framework that can be used to create many things, including:

  • Standalone documentation websites
  • OpenAPI powered API references
  • A developer portal with documentation, fully functional API reference for testing and authentication support for your user accounts.
  • Internal documentation

🔧 Contributing & Community

For details on how to contribute to Zudoku, see the contributing guide.

Changelog

Details of the latest updates to Zudoku can be found in the changelog.

🎯 Motivation

At Zuplo, we couldn’t find an open-source solution that met our high standards for both trustworthiness and programmability, so we decided to create our own. And since no one chooses Zuplo solely because of our documentation, we felt great about open-sourcing this tool and making it easy for anyone to self-host.

We hope that if you use it, you’ll think fondly of Zuplo, and one day, when you’re looking for a gateway or API management product, you’ll consider us as a vendor to evaluate.

Zudoku will always be open-source. It will always be free.

License

Zudoku is licensed under MIT. See the full license.

0.0.0-58fc799

8 months ago

0.0.0-85cb7b2

8 months ago

0.13.4

8 months ago

0.0.0-0f32e1f

8 months ago

0.0.0-a756274

8 months ago

0.0.0-794f734

8 months ago

0.0.0-b8f0127

8 months ago

0.0.0-e259486

8 months ago

0.0.0-78f52e0

8 months ago

0.0.0-73bf6ec

8 months ago

0.0.0-4893874

8 months ago

0.0.0-73240f4

8 months ago

0.0.0-aaf5d64

8 months ago

0.0.0-e4b82fa

8 months ago

0.0.0-3aa415a

8 months ago

0.0.0-8ee574f

8 months ago

0.0.0-c81af9c

8 months ago

0.0.0-04430f7

8 months ago

0.0.0-0fddb83

8 months ago

0.0.0-e8abed1

8 months ago

0.0.0-c122c8a

9 months ago

0.13.3

9 months ago

0.0.0-89b1458

9 months ago

0.0.0-9736f1d

9 months ago

0.0.0-826bf91

9 months ago

0.0.0-7ea194f

9 months ago

0.0.0-8f3e24d

10 months ago

0.0.0-11eaa0d

9 months ago

0.0.0-10751944706

10 months ago

0.0.0-2036b49

9 months ago

0.0.0-3fa05ba

9 months ago

0.0.0-9c01fde

9 months ago

0.7.1

10 months ago

0.0.0-a2b1879

9 months ago

0.7.0

10 months ago

0.0.0-8fdbf0c

9 months ago

0.0.0-e3f7e48

9 months ago

0.0.0-dafba3e

9 months ago

0.0.0-e131151

9 months ago

0.0.0-fed343e

10 months ago

0.0.0-437c93f

9 months ago

0.0.0-320016e

10 months ago

0.0.0-7cfd90e

9 months ago

0.0.0-ddbae91

9 months ago

0.0.0-36529df

9 months ago

0.0.0-0d28ae1

9 months ago

0.4.5-dev.1

10 months ago

0.4.5-dev.2

10 months ago

0.10.0

10 months ago

0.4.5-dev.0

10 months ago

0.0.0-f3858d6

9 months ago

0.8.0

10 months ago

0.0.0-740d272

9 months ago

0.4.4-dev.11

10 months ago

0.4.4-dev.12

10 months ago

0.4.4-dev.10

10 months ago

0.0.0-c1209b9

9 months ago

0.0.0-df9ed40

9 months ago

0.0.0-7b1fa80

9 months ago

0.0.0-f5761c9

9 months ago

0.0.0-fcb84d6

9 months ago

0.0.0-b5f531c

9 months ago

0.0.0-d70f2ab

10 months ago

0.5.0

10 months ago

0.5.1

10 months ago

0.0.0-4a034b4

9 months ago

0.0.0-820f792

9 months ago

0.4.6-dev.4

10 months ago

0.0.0-36db101

10 months ago

0.4.6-dev.0

10 months ago

0.4.6-dev.1

10 months ago

0.4.6-dev.2

10 months ago

0.4.6-dev.3

10 months ago

0.0.0-eb0425e

9 months ago

0.0.0-bbd5f64

9 months ago

0.0.0-aa993bd

9 months ago

0.0.0-acbebd9

9 months ago

0.0.0-8d749d2

9 months ago

0.0.0-00e5320

10 months ago

0.0.0-f114fe8

9 months ago

0.0.0-900d1b0

9 months ago

0.6.1

10 months ago

0.6.0

10 months ago

0.0.0-75e17ef

9 months ago

0.0.0-879f5c0

9 months ago

0.13.0

9 months ago

0.13.1

9 months ago

0.13.2

9 months ago

0.4.3-dev.22

10 months ago

0.4.3-dev.21

10 months ago

0.4.3-dev.20

10 months ago

0.4.3-dev.26

10 months ago

0.0.0-191c5bb

10 months ago

0.4.3-dev.25

10 months ago

0.4.3-dev.24

10 months ago

0.4.3-dev.23

10 months ago

0.4.3-dev.28

10 months ago

0.7.1-dev.0

10 months ago

0.4.3-dev.27

10 months ago

0.0.0-9b553c0

9 months ago

0.0.0-10752126486

10 months ago

0.0.0-68cb858

9 months ago

0.0.0-5fe5bd7

9 months ago

0.0.0-a93c194

9 months ago

0.0.0-aa36241

9 months ago

0.0.0-b1f2c3d

9 months ago

0.0.0-eff6f9b

9 months ago

0.0.0-04d0a62

10 months ago

0.0.0-8983ecc

9 months ago

0.0.0-746df24

9 months ago

0.0.0-c1e6770

9 months ago

0.5.2-dev.3

10 months ago

0.0.0-2569d1f

9 months ago

0.11.0

9 months ago

0.0.0-232a273

10 months ago

0.5.2-dev.0

10 months ago

0.5.2-dev.1

10 months ago

0.0.0-16bc34d

9 months ago

0.5.2-dev.2

10 months ago

0.0.0-56af5a8

10 months ago

0.4.3-dev.1

10 months ago

0.4.3-dev.2

10 months ago

0.4.3-dev.0

10 months ago

0.0.0-6c5737d

9 months ago

0.9.0

10 months ago

0.4.3-dev.9

10 months ago

0.4.3-dev.7

10 months ago

0.4.3-dev.8

10 months ago

0.4.3-dev.5

10 months ago

0.0.0-3f64b57

9 months ago

0.4.3-dev.6

10 months ago

0.4.3-dev.3

10 months ago

0.4.3-dev.4

10 months ago

0.4.3-dev.11

10 months ago

0.4.3-dev.10

10 months ago

0.4.3-dev.15

10 months ago

0.4.3-dev.14

10 months ago

0.4.3-dev.13

10 months ago

0.4.3-dev.12

10 months ago

0.4.3-dev.19

10 months ago

0.4.3-dev.18

10 months ago

0.4.3-dev.17

10 months ago

0.4.3-dev.16

10 months ago

0.0.0-0c460ef

10 months ago

0.12.0

9 months ago

0.0.0-357687e

9 months ago

0.12.1

9 months ago

0.12.2

9 months ago

0.0.0-a78f364

10 months ago

0.0.0-2332f01

9 months ago

0.0.0-eb4182d

9 months ago

0.0.0-dac25f2

9 months ago

0.0.0-ff3bc72

9 months ago

0.4.2-dev.11

10 months ago

0.4.2-dev.12

10 months ago

0.4.2-dev.13

10 months ago

0.4.2-dev.10

10 months ago

0.0.0-943876e

9 months ago

0.0.0-d9bccc9

9 months ago

0.0.0-38facfc

9 months ago

0.0.0-463d888

10 months ago

0.0.0-c3bc69c

9 months ago

0.0.0-7a50514

9 months ago

0.7.2-dev.11

10 months ago

0.7.2-dev.12

10 months ago

0.0.0-efc6acf

9 months ago

0.7.2-dev.13

10 months ago

0.7.2-dev.14

10 months ago

0.0.0-c807506

9 months ago

0.0.0-aa16480

9 months ago

0.0.0-7d5e32d

9 months ago

0.0.0-9674cb5

9 months ago

0.0.0-1a9e2e9

9 months ago

0.6.1-dev.3

10 months ago

0.0.0-e4d0ea8

9 months ago

0.0.0-70958d7

9 months ago

0.6.1-dev.1

10 months ago

0.6.1-dev.2

10 months ago

0.6.1-dev.0

10 months ago

0.0.0-95cefaa

9 months ago

0.0.0-6f94e87

9 months ago

0.0.0-ad4a539

9 months ago

0.0.0-a52ae3c

9 months ago

0.0.0-463a8f3

9 months ago

0.0.0-d542b95

9 months ago

0.0.0-df0b125

10 months ago

0.6.2-dev.0

10 months ago

0.0.0-d9e55be

9 months ago

0.6.2-dev.1

10 months ago

0.0.0-40acb94

9 months ago

0.6.2-dev.6

10 months ago

0.0.0-e068f8b

9 months ago

0.6.2-dev.7

10 months ago

0.6.2-dev.8

10 months ago

0.6.2-dev.9

10 months ago

0.6.2-dev.2

10 months ago

0.6.2-dev.3

10 months ago

0.6.2-dev.4

10 months ago

0.6.2-dev.5

10 months ago

0.0.0-7a05886

9 months ago

0.0.0-f1a6fd4

9 months ago

0.0.0-497680d

9 months ago

0.0.0-46dec80

9 months ago

0.0.0-16f2eeb

9 months ago

0.0.0-57e713b

9 months ago

0.7.2-dev.2

10 months ago

0.7.2-dev.1

10 months ago

0.7.2-dev.0

10 months ago

0.0.0-9455393

9 months ago

0.0.0-832f526

9 months ago

0.0.0-ae50909

9 months ago

0.0.0-76bbec5

9 months ago

0.0.0-e639b62

9 months ago

0.0.0-02d4e33

9 months ago

0.0.0-4a9ad0c

10 months ago

0.0.0-06ab118

9 months ago

0.0.0-e09234c

9 months ago

0.0.0-060fa31

9 months ago

0.0.0-d99ad45

9 months ago

0.4.2-dev.9

10 months ago

0.4.2-dev.8

10 months ago

0.4.2-dev.5

10 months ago

0.0.0-8479457

9 months ago

0.4.2-dev.4

10 months ago

0.4.2-dev.7

10 months ago

0.4.2-dev.6

10 months ago

0.0.0-41e6162

9 months ago

0.0.0-9a4e53b

9 months ago

0.0.0-94f3c96

9 months ago

0.4.5

10 months ago

0.4.4

10 months ago

0.0.0-eb5886a

9 months ago

0.0.0-436b432

9 months ago

0.4.3

10 months ago

0.4.2

10 months ago

0.0.0-976ca18

9 months ago

0.0.0-4f9cfb7

10 months ago

0.0.0-3da17ef

9 months ago

0.0.0-6ba18b8

9 months ago

0.4.4-dev.0

10 months ago

0.4.4-dev.1

10 months ago

0.4.4-dev.2

10 months ago

0.4.4-dev.3

10 months ago

0.0.0-bb06230

9 months ago

0.4.4-dev.4

10 months ago

0.4.4-dev.5

10 months ago

0.4.4-dev.6

10 months ago

0.4.4-dev.7

10 months ago

0.4.4-dev.8

10 months ago

0.4.4-dev.9

10 months ago

0.0.0-125e475

9 months ago

0.0.0-e53033e

9 months ago

0.0.0-0b66b3f

9 months ago

0.0.0-cc62e31

9 months ago

0.5.1-dev.0

10 months ago

0.0.0-f2a195f

9 months ago

0.0.0-014a0f2

9 months ago

0.0.0-e2f3304

9 months ago

0.0.0-1cb1db2

9 months ago

0.3.0-dev.89

11 months ago

0.3.1-dev.22

10 months ago

0.3.1-dev.21

10 months ago

0.3.1-dev.20

10 months ago

0.3.0-dev.80

11 months ago

0.3.0-dev.81

11 months ago

0.3.0-dev.82

11 months ago

0.3.0-dev.83

11 months ago

0.3.0-dev.84

11 months ago

0.3.0-dev.85

11 months ago

0.3.0-dev.86

11 months ago

0.3.0-dev.87

11 months ago

0.3.0-dev.88

11 months ago

0.3.1-dev.12

10 months ago

0.3.1-dev.11

10 months ago

0.3.1-dev.10

10 months ago

0.3.0-dev.90

11 months ago

0.3.0-dev.91

11 months ago

0.3.0-dev.92

11 months ago

0.3.1-dev.19

10 months ago

0.3.0-dev.93

11 months ago

0.3.1-dev.18

10 months ago

0.3.0-dev.94

11 months ago

0.3.1-dev.17

10 months ago

0.3.0-dev.95

11 months ago

0.3.1-dev.16

10 months ago

0.3.0-dev.96

11 months ago

0.3.1-dev.15

10 months ago

0.3.0-dev.97

11 months ago

0.3.1-dev.14

10 months ago

0.3.0-dev.98

11 months ago

0.3.1-dev.13

10 months ago

0.3.0-dev.99

11 months ago

0.3.1-dev.5

11 months ago

0.3.1-dev.4

11 months ago

0.3.1-dev.3

11 months ago

0.3.1-dev.2

11 months ago

0.3.1-dev.1

11 months ago

0.3.1-dev.0

11 months ago

0.3.1-dev.9

10 months ago

0.3.1-dev.8

10 months ago

0.3.1-dev.7

10 months ago

0.3.1-dev.6

10 months ago

0.0.2-dev.0

1 year ago

0.3.0-dev.45

11 months ago

0.3.0-dev.46

11 months ago

0.3.0-dev.47

11 months ago

0.3.0-dev.48

11 months ago

0.3.0-dev.49

11 months ago

0.3.0-dev.40

11 months ago

0.3.0-dev.41

11 months ago

0.3.0-dev.42

11 months ago

0.3.0-dev.43

11 months ago

0.3.0-dev.44

11 months ago

0.3.0-dev.56

11 months ago

0.3.0-dev.57

11 months ago

0.3.0-dev.58

11 months ago

0.3.0-dev.59

11 months ago

0.3.0-dev.50

11 months ago

0.3.0-dev.51

11 months ago

0.3.0-dev.52

11 months ago

0.3.0-dev.53

11 months ago

0.3.0-dev.54

11 months ago

0.3.0-dev.55

11 months ago

0.3.0-dev.67

11 months ago

0.3.0-dev.68

11 months ago

0.3.0-dev.69

11 months ago

0.1.1-dev.0

1 year ago

0.1.1-dev.1

1 year ago

0.1.1-dev.2

1 year ago

0.1.1-dev.3

1 year ago

0.1.1-dev.4

1 year ago

0.1.1-dev.5

1 year ago

0.1.1-dev.6

1 year ago

0.1.1-dev.7

1 year ago

0.1.1-dev.8

1 year ago

0.3.0-dev.60

11 months ago

0.1.1-dev.9

12 months ago

0.3.0-dev.61

11 months ago

0.3.0-dev.62

11 months ago

0.3.0-dev.63

11 months ago

0.3.0-dev.64

11 months ago

0.3.0-dev.65

11 months ago

0.3.0-dev.66

11 months ago

0.3.0-dev.78

11 months ago

0.3.0-dev.79

11 months ago

0.3.0-dev.70

11 months ago

0.3.0-dev.71

11 months ago

0.3.0-dev.72

11 months ago

0.3.0-dev.73

11 months ago

0.3.0-dev.74

11 months ago

0.3.0-dev.75

11 months ago

0.3.0-dev.76

11 months ago

0.3.0-dev.77

11 months ago

0.4.1-dev.0

10 months ago

0.1.1-dev.10

12 months ago

0.3.0-dev.119

11 months ago

0.1.1-dev.13

12 months ago

0.1.1-dev.14

12 months ago

0.1.1-dev.11

12 months ago

0.3.0-dev.118

11 months ago

0.1.1-dev.12

12 months ago

0.1.1-dev.17

12 months ago

0.1.1-dev.18

12 months ago

0.1.1-dev.15

12 months ago

0.1.1-dev.16

12 months ago

0.3.0-dev.111

11 months ago

0.3.0-dev.112

11 months ago

0.1.1-dev.19

12 months ago

0.3.0-dev.110

11 months ago

0.3.0-dev.115

11 months ago

0.3.0-dev.116

11 months ago

0.3.0-dev.114

11 months ago

0.3.0-dev.12

12 months ago

0.3.0-dev.13

12 months ago

0.3.0-dev.14

12 months ago

0.3.0-dev.15

12 months ago

0.3.0-dev.16

12 months ago

0.3.0-dev.17

12 months ago

0.3.0-dev.18

12 months ago

0.3.0-dev.19

12 months ago

0.1.1-dev.20

12 months ago

0.1.1-dev.21

12 months ago

0.3.0-dev.108

11 months ago

0.1.1-dev.24

12 months ago

0.3.0-dev.109

11 months ago

0.1.1-dev.25

12 months ago

0.3.0

11 months ago

0.3.0-dev.106

11 months ago

0.1.1-dev.22

12 months ago

0.3.0-dev.107

11 months ago

0.1.1-dev.23

12 months ago

0.1.1-dev.28

12 months ago

0.1.1-dev.29

12 months ago

0.1.1-dev.26

12 months ago

0.1.1-dev.27

12 months ago

0.3.0-dev.100

11 months ago

0.3.0-dev.101

11 months ago

0.3.0-dev.104

11 months ago

0.3.0-dev.105

11 months ago

0.3.0-dev.102

11 months ago

0.3.0-dev.10

12 months ago

0.3.0-dev.103

11 months ago

0.3.0-dev.11

12 months ago

0.3.0-dev.23

12 months ago

0.3.0-dev.24

12 months ago

0.3.0-dev.26

12 months ago

0.3.0-dev.27

12 months ago

0.3.0-dev.28

12 months ago

0.3.0-dev.29

12 months ago

0.4.2-dev.1

10 months ago

0.4.2-dev.0

10 months ago

0.4.2-dev.3

10 months ago

0.4.2-dev.2

10 months ago

0.3.0-dev.20

12 months ago

0.3.0-dev.21

12 months ago

0.3.0-dev.22

12 months ago

0.3.0-dev.34

11 months ago

0.3.0-dev.35

11 months ago

0.3.0-dev.36

11 months ago

0.3.0-dev.37

11 months ago

0.3.0-dev.38

11 months ago

0.3.0-dev.39

11 months ago

0.4.1

10 months ago

0.3.0-dev.30

12 months ago

0.4.0

10 months ago

0.3.0-dev.31

12 months ago

0.3.0-dev.32

11 months ago

0.3.0-dev.33

11 months ago

0.1.1-dev.50

12 months ago

0.1.1-dev.53

12 months ago

0.1.1-dev.54

12 months ago

0.1.1-dev.51

12 months ago

0.1.1-dev.52

12 months ago

0.1.1-dev.55

12 months ago

0.1.1-dev.56

12 months ago

0.3.0-dev.140

11 months ago

0.1.1-dev.31

12 months ago

0.1.1-dev.32

12 months ago

0.1.1-dev.30

12 months ago

0.1.1-dev.35

12 months ago

0.1.1-dev.36

12 months ago

0.3.0-dev.139

11 months ago

0.1.1-dev.33

12 months ago

0.1.1-dev.34

12 months ago

0.1.1-dev.39

12 months ago

0.1.1-dev.37

12 months ago

0.1.1-dev.38

12 months ago

0.3.0-dev.133

11 months ago

0.3.0-dev.131

11 months ago

0.3.0-dev.138

11 months ago

0.3.0-dev.8

12 months ago

0.3.0-dev.130

11 months ago

0.3.0-dev.7

12 months ago

0.3.0-dev.9

12 months ago

0.3.0-dev.4

12 months ago

0.3.0-dev.3

12 months ago

0.3.0-dev.6

12 months ago

0.3.0-dev.5

12 months ago

0.1.1-dev.42

12 months ago

0.1.1-dev.43

12 months ago

0.3.0-dev.2

12 months ago

0.1.1-dev.40

12 months ago

0.1.1-dev.41

12 months ago

0.1.1-dev.46

12 months ago

0.1.1-dev.47

12 months ago

0.3.0-dev.128

11 months ago

0.1.1-dev.44

12 months ago

0.3.0-dev.129

11 months ago

0.1.1-dev.45

12 months ago

0.1.1-dev.48

12 months ago

0.1.1-dev.49

12 months ago

0.3.0-dev.122

11 months ago

0.3.0-dev.123

11 months ago

0.3.0-dev.120

11 months ago

0.3.0-dev.121

11 months ago

0.3.0-dev.126

11 months ago

0.3.0-dev.127

11 months ago

0.3.0-dev.124

11 months ago

0.3.0-dev.125

11 months ago

1.0.0

1 year ago