0.13.4 • Published 11 months ago

zudoku v0.13.4

Weekly downloads
-
License
-
Repository
github
Last release
11 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

11 months ago

0.0.0-85cb7b2

11 months ago

0.13.4

11 months ago

0.0.0-0f32e1f

11 months ago

0.0.0-a756274

11 months ago

0.0.0-794f734

11 months ago

0.0.0-b8f0127

11 months ago

0.0.0-e259486

11 months ago

0.0.0-78f52e0

11 months ago

0.0.0-73bf6ec

11 months ago

0.0.0-4893874

11 months ago

0.0.0-73240f4

11 months ago

0.0.0-aaf5d64

11 months ago

0.0.0-e4b82fa

11 months ago

0.0.0-3aa415a

11 months ago

0.0.0-8ee574f

11 months ago

0.0.0-c81af9c

11 months ago

0.0.0-04430f7

11 months ago

0.0.0-0fddb83

11 months ago

0.0.0-e8abed1

11 months ago

0.0.0-c122c8a

11 months ago

0.13.3

11 months ago

0.0.0-89b1458

11 months ago

0.0.0-9736f1d

11 months ago

0.0.0-826bf91

11 months ago

0.0.0-7ea194f

11 months ago

0.0.0-8f3e24d

1 year ago

0.0.0-11eaa0d

11 months ago

0.0.0-2036b49

12 months ago

0.0.0-3fa05ba

12 months ago

0.0.0-9c01fde

11 months ago

0.7.1

1 year ago

0.0.0-a2b1879

11 months ago

0.7.0

1 year ago

0.0.0-8fdbf0c

12 months ago

0.0.0-e3f7e48

12 months ago

0.0.0-dafba3e

12 months ago

0.0.0-e131151

11 months ago

0.0.0-fed343e

1 year ago

0.0.0-437c93f

12 months ago

0.0.0-320016e

1 year ago

0.0.0-7cfd90e

11 months ago

0.0.0-ddbae91

12 months ago

0.0.0-36529df

12 months ago

0.0.0-0d28ae1

11 months ago

0.4.5-dev.1

1 year ago

0.4.5-dev.2

1 year ago

0.10.0

1 year ago

0.4.5-dev.0

1 year ago

0.0.0-f3858d6

11 months ago

0.8.0

1 year ago

0.0.0-740d272

11 months ago

0.4.4-dev.11

1 year ago

0.4.4-dev.12

1 year ago

0.4.4-dev.10

1 year ago

0.0.0-c1209b9

11 months ago

0.0.0-df9ed40

12 months ago

0.0.0-7b1fa80

12 months ago

0.0.0-f5761c9

12 months ago

0.0.0-fcb84d6

11 months ago

0.0.0-b5f531c

12 months ago

0.0.0-d70f2ab

1 year ago

0.5.0

1 year ago

0.5.1

1 year ago

0.0.0-4a034b4

12 months ago

0.0.0-820f792

11 months ago

0.4.6-dev.4

1 year ago

0.0.0-36db101

1 year ago

0.4.6-dev.0

1 year ago

0.4.6-dev.1

1 year ago

0.4.6-dev.2

1 year ago

0.4.6-dev.3

1 year ago

0.0.0-eb0425e

12 months ago

0.0.0-bbd5f64

12 months ago

0.0.0-aa993bd

12 months ago

0.0.0-acbebd9

11 months ago

0.0.0-8d749d2

12 months ago

0.0.0-00e5320

1 year ago

0.0.0-f114fe8

12 months ago

0.0.0-900d1b0

12 months ago

0.6.1

1 year ago

0.6.0

1 year ago

0.0.0-75e17ef

11 months ago

0.0.0-879f5c0

11 months ago

0.13.0

11 months ago

0.13.1

11 months ago

0.13.2

11 months ago

0.4.3-dev.22

1 year ago

0.4.3-dev.21

1 year ago

0.4.3-dev.20

1 year ago

0.4.3-dev.26

1 year ago

0.0.0-191c5bb

1 year ago

0.4.3-dev.25

1 year ago

0.4.3-dev.24

1 year ago

0.4.3-dev.23

1 year ago

0.4.3-dev.28

1 year ago

0.7.1-dev.0

1 year ago

0.4.3-dev.27

1 year ago

0.0.0-9b553c0

12 months ago

0.0.0-68cb858

11 months ago

0.0.0-5fe5bd7

12 months ago

0.0.0-a93c194

12 months ago

0.0.0-aa36241

12 months ago

0.0.0-b1f2c3d

11 months ago

0.0.0-eff6f9b

12 months ago

0.0.0-04d0a62

1 year ago

0.0.0-8983ecc

12 months ago

0.0.0-746df24

12 months ago

0.0.0-c1e6770

12 months ago

0.5.2-dev.3

1 year ago

0.0.0-2569d1f

11 months ago

0.11.0

12 months ago

0.0.0-232a273

1 year ago

0.5.2-dev.0

1 year ago

0.5.2-dev.1

1 year ago

0.0.0-16bc34d

11 months ago

0.5.2-dev.2

1 year ago

0.0.0-56af5a8

1 year ago

0.4.3-dev.1

1 year ago

0.4.3-dev.2

1 year ago

0.4.3-dev.0

1 year ago

0.0.0-6c5737d

11 months ago

0.9.0

1 year ago

0.4.3-dev.9

1 year ago

0.4.3-dev.7

1 year ago

0.4.3-dev.8

1 year ago

0.4.3-dev.5

1 year ago

0.0.0-3f64b57

11 months ago

0.4.3-dev.6

1 year ago

0.4.3-dev.3

1 year ago

0.4.3-dev.4

1 year ago

0.4.3-dev.11

1 year ago

0.4.3-dev.10

1 year ago

0.4.3-dev.15

1 year ago

0.4.3-dev.14

1 year ago

0.4.3-dev.13

1 year ago

0.4.3-dev.12

1 year ago

0.4.3-dev.19

1 year ago

0.4.3-dev.18

1 year ago

0.4.3-dev.17

1 year ago

0.4.3-dev.16

1 year ago

0.0.0-0c460ef

1 year ago

0.12.0

12 months ago

0.0.0-357687e

12 months ago

0.12.1

12 months ago

0.12.2

12 months ago

0.0.0-a78f364

1 year ago

0.0.0-2332f01

12 months ago

0.0.0-eb4182d

12 months ago

0.0.0-dac25f2

12 months ago

0.0.0-ff3bc72

11 months ago

0.4.2-dev.11

1 year ago

0.4.2-dev.12

1 year ago

0.4.2-dev.13

1 year ago

0.4.2-dev.10

1 year ago

0.0.0-943876e

12 months ago

0.0.0-d9bccc9

12 months ago

0.0.0-38facfc

11 months ago

0.0.0-463d888

1 year ago

0.0.0-c3bc69c

12 months ago

0.0.0-7a50514

12 months ago

0.7.2-dev.11

1 year ago

0.7.2-dev.12

1 year ago

0.0.0-efc6acf

11 months ago

0.7.2-dev.13

1 year ago

0.7.2-dev.14

1 year ago

0.0.0-c807506

12 months ago

0.0.0-aa16480

12 months ago

0.0.0-7d5e32d

12 months ago

0.0.0-9674cb5

12 months ago

0.0.0-1a9e2e9

11 months ago

0.6.1-dev.3

1 year ago

0.0.0-e4d0ea8

11 months ago

0.0.0-70958d7

11 months ago

0.6.1-dev.1

1 year ago

0.6.1-dev.2

1 year ago

0.6.1-dev.0

1 year ago

0.0.0-95cefaa

11 months ago

0.0.0-6f94e87

11 months ago

0.0.0-ad4a539

12 months ago

0.0.0-a52ae3c

12 months ago

0.0.0-463a8f3

12 months ago

0.0.0-d542b95

11 months ago

0.0.0-df0b125

1 year ago

0.6.2-dev.0

1 year ago

0.0.0-d9e55be

11 months ago

0.6.2-dev.1

1 year ago

0.0.0-40acb94

12 months ago

0.6.2-dev.6

1 year ago

0.0.0-e068f8b

12 months ago

0.6.2-dev.7

1 year ago

0.6.2-dev.8

1 year ago

0.6.2-dev.9

1 year ago

0.6.2-dev.2

1 year ago

0.6.2-dev.3

1 year ago

0.6.2-dev.4

1 year ago

0.6.2-dev.5

1 year ago

0.0.0-7a05886

11 months ago

0.0.0-f1a6fd4

11 months ago

0.0.0-497680d

12 months ago

0.0.0-46dec80

11 months ago

0.0.0-16f2eeb

12 months ago

0.0.0-57e713b

12 months ago

0.7.2-dev.2

1 year ago

0.7.2-dev.1

1 year ago

0.7.2-dev.0

1 year ago

0.0.0-9455393

12 months ago

0.0.0-832f526

12 months ago

0.0.0-ae50909

12 months ago

0.0.0-76bbec5

12 months ago

0.0.0-e639b62

12 months ago

0.0.0-02d4e33

12 months ago

0.0.0-4a9ad0c

1 year ago

0.0.0-06ab118

12 months ago

0.0.0-e09234c

11 months ago

0.0.0-060fa31

11 months ago

0.0.0-d99ad45

11 months ago

0.4.2-dev.9

1 year ago

0.4.2-dev.8

1 year ago

0.4.2-dev.5

1 year ago

0.0.0-8479457

12 months ago

0.4.2-dev.4

1 year ago

0.4.2-dev.7

1 year ago

0.4.2-dev.6

1 year ago

0.0.0-41e6162

12 months ago

0.0.0-9a4e53b

11 months ago

0.0.0-94f3c96

12 months ago

0.4.5

1 year ago

0.4.4

1 year ago

0.0.0-eb5886a

12 months ago

0.0.0-436b432

12 months ago

0.4.3

1 year ago

0.4.2

1 year ago

0.0.0-976ca18

11 months ago

0.0.0-4f9cfb7

1 year ago

0.0.0-3da17ef

12 months ago

0.0.0-6ba18b8

12 months ago

0.4.4-dev.0

1 year ago

0.4.4-dev.1

1 year ago

0.4.4-dev.2

1 year ago

0.4.4-dev.3

1 year ago

0.0.0-bb06230

12 months ago

0.4.4-dev.4

1 year ago

0.4.4-dev.5

1 year ago

0.4.4-dev.6

1 year ago

0.4.4-dev.7

1 year ago

0.4.4-dev.8

1 year ago

0.4.4-dev.9

1 year ago

0.0.0-125e475

11 months ago

0.0.0-e53033e

11 months ago

0.0.0-0b66b3f

12 months ago

0.0.0-cc62e31

11 months ago

0.5.1-dev.0

1 year ago

0.0.0-f2a195f

11 months ago

0.0.0-014a0f2

12 months ago

0.0.0-e2f3304

12 months ago

0.0.0-1cb1db2

12 months ago

0.3.0-dev.89

1 year ago

0.3.1-dev.22

1 year ago

0.3.1-dev.21

1 year ago

0.3.1-dev.20

1 year ago

0.3.0-dev.80

1 year ago

0.3.0-dev.81

1 year ago

0.3.0-dev.82

1 year ago

0.3.0-dev.83

1 year ago

0.3.0-dev.84

1 year ago

0.3.0-dev.85

1 year ago

0.3.0-dev.86

1 year ago

0.3.0-dev.87

1 year ago

0.3.0-dev.88

1 year ago

0.3.1-dev.12

1 year ago

0.3.1-dev.11

1 year ago

0.3.1-dev.10

1 year ago

0.3.0-dev.90

1 year ago

0.3.0-dev.91

1 year ago

0.3.0-dev.92

1 year ago

0.3.1-dev.19

1 year ago

0.3.0-dev.93

1 year ago

0.3.1-dev.18

1 year ago

0.3.0-dev.94

1 year ago

0.3.1-dev.17

1 year ago

0.3.0-dev.95

1 year ago

0.3.1-dev.16

1 year ago

0.3.0-dev.96

1 year ago

0.3.1-dev.15

1 year ago

0.3.0-dev.97

1 year ago

0.3.1-dev.14

1 year ago

0.3.0-dev.98

1 year ago

0.3.1-dev.13

1 year ago

0.3.0-dev.99

1 year ago

0.3.1-dev.5

1 year ago

0.3.1-dev.4

1 year ago

0.3.1-dev.3

1 year ago

0.3.1-dev.2

1 year ago

0.3.1-dev.1

1 year ago

0.3.1-dev.0

1 year ago

0.3.1-dev.9

1 year ago

0.3.1-dev.8

1 year ago

0.3.1-dev.7

1 year ago

0.3.1-dev.6

1 year ago

0.0.2-dev.0

1 year ago

0.3.0-dev.45

1 year ago

0.3.0-dev.46

1 year ago

0.3.0-dev.47

1 year ago

0.3.0-dev.48

1 year ago

0.3.0-dev.49

1 year ago

0.3.0-dev.40

1 year ago

0.3.0-dev.41

1 year ago

0.3.0-dev.42

1 year ago

0.3.0-dev.43

1 year ago

0.3.0-dev.44

1 year ago

0.3.0-dev.56

1 year ago

0.3.0-dev.57

1 year ago

0.3.0-dev.58

1 year ago

0.3.0-dev.59

1 year ago

0.3.0-dev.50

1 year ago

0.3.0-dev.51

1 year ago

0.3.0-dev.52

1 year ago

0.3.0-dev.53

1 year ago

0.3.0-dev.54

1 year ago

0.3.0-dev.55

1 year ago

0.3.0-dev.67

1 year ago

0.3.0-dev.68

1 year ago

0.3.0-dev.69

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

1 year ago

0.1.1-dev.9

1 year ago

0.3.0-dev.61

1 year ago

0.3.0-dev.62

1 year ago

0.3.0-dev.63

1 year ago

0.3.0-dev.64

1 year ago

0.3.0-dev.65

1 year ago

0.3.0-dev.66

1 year ago

0.3.0-dev.78

1 year ago

0.3.0-dev.79

1 year ago

0.3.0-dev.70

1 year ago

0.3.0-dev.71

1 year ago

0.3.0-dev.72

1 year ago

0.3.0-dev.73

1 year ago

0.3.0-dev.74

1 year ago

0.3.0-dev.75

1 year ago

0.3.0-dev.76

1 year ago

0.3.0-dev.77

1 year ago

0.4.1-dev.0

1 year ago

0.1.1-dev.10

1 year ago

0.3.0-dev.119

1 year ago

0.1.1-dev.13

1 year ago

0.1.1-dev.14

1 year ago

0.1.1-dev.11

1 year ago

0.3.0-dev.118

1 year ago

0.1.1-dev.12

1 year ago

0.1.1-dev.17

1 year ago

0.1.1-dev.18

1 year ago

0.1.1-dev.15

1 year ago

0.1.1-dev.16

1 year ago

0.3.0-dev.111

1 year ago

0.3.0-dev.112

1 year ago

0.1.1-dev.19

1 year ago

0.3.0-dev.110

1 year ago

0.3.0-dev.115

1 year ago

0.3.0-dev.116

1 year ago

0.3.0-dev.114

1 year ago

0.3.0-dev.12

1 year ago

0.3.0-dev.13

1 year ago

0.3.0-dev.14

1 year ago

0.3.0-dev.15

1 year ago

0.3.0-dev.16

1 year ago

0.3.0-dev.17

1 year ago

0.3.0-dev.18

1 year ago

0.3.0-dev.19

1 year ago

0.1.1-dev.20

1 year ago

0.1.1-dev.21

1 year ago

0.3.0-dev.108

1 year ago

0.1.1-dev.24

1 year ago

0.3.0-dev.109

1 year ago

0.1.1-dev.25

1 year ago

0.3.0

1 year ago

0.3.0-dev.106

1 year ago

0.1.1-dev.22

1 year ago

0.3.0-dev.107

1 year ago

0.1.1-dev.23

1 year ago

0.1.1-dev.28

1 year ago

0.1.1-dev.29

1 year ago

0.1.1-dev.26

1 year ago

0.1.1-dev.27

1 year ago

0.3.0-dev.100

1 year ago

0.3.0-dev.101

1 year ago

0.3.0-dev.104

1 year ago

0.3.0-dev.105

1 year ago

0.3.0-dev.102

1 year ago

0.3.0-dev.10

1 year ago

0.3.0-dev.103

1 year ago

0.3.0-dev.11

1 year ago

0.3.0-dev.23

1 year ago

0.3.0-dev.24

1 year ago

0.3.0-dev.26

1 year ago

0.3.0-dev.27

1 year ago

0.3.0-dev.28

1 year ago

0.3.0-dev.29

1 year ago

0.4.2-dev.1

1 year ago

0.4.2-dev.0

1 year ago

0.4.2-dev.3

1 year ago

0.4.2-dev.2

1 year ago

0.3.0-dev.20

1 year ago

0.3.0-dev.21

1 year ago

0.3.0-dev.22

1 year ago

0.3.0-dev.34

1 year ago

0.3.0-dev.35

1 year ago

0.3.0-dev.36

1 year ago

0.3.0-dev.37

1 year ago

0.3.0-dev.38

1 year ago

0.3.0-dev.39

1 year ago

0.4.1

1 year ago

0.3.0-dev.30

1 year ago

0.4.0

1 year ago

0.3.0-dev.31

1 year ago

0.3.0-dev.32

1 year ago

0.3.0-dev.33

1 year ago

0.1.1-dev.50

1 year ago

0.1.1-dev.53

1 year ago

0.1.1-dev.54

1 year ago

0.1.1-dev.51

1 year ago

0.1.1-dev.52

1 year ago

0.1.1-dev.55

1 year ago

0.1.1-dev.56

1 year ago

0.3.0-dev.140

1 year ago

0.1.1-dev.31

1 year ago

0.1.1-dev.32

1 year ago

0.1.1-dev.30

1 year ago

0.1.1-dev.35

1 year ago

0.1.1-dev.36

1 year ago

0.3.0-dev.139

1 year ago

0.1.1-dev.33

1 year ago

0.1.1-dev.34

1 year ago

0.1.1-dev.39

1 year ago

0.1.1-dev.37

1 year ago

0.1.1-dev.38

1 year ago

0.3.0-dev.133

1 year ago

0.3.0-dev.131

1 year ago

0.3.0-dev.138

1 year ago

0.3.0-dev.8

1 year ago

0.3.0-dev.130

1 year ago

0.3.0-dev.7

1 year ago

0.3.0-dev.9

1 year ago

0.3.0-dev.4

1 year ago

0.3.0-dev.3

1 year ago

0.3.0-dev.6

1 year ago

0.3.0-dev.5

1 year ago

0.1.1-dev.42

1 year ago

0.1.1-dev.43

1 year ago

0.3.0-dev.2

1 year ago

0.1.1-dev.40

1 year ago

0.1.1-dev.41

1 year ago

0.1.1-dev.46

1 year ago

0.1.1-dev.47

1 year ago

0.3.0-dev.128

1 year ago

0.1.1-dev.44

1 year ago

0.3.0-dev.129

1 year ago

0.1.1-dev.45

1 year ago

0.1.1-dev.48

1 year ago

0.1.1-dev.49

1 year ago

0.3.0-dev.122

1 year ago

0.3.0-dev.123

1 year ago

0.3.0-dev.120

1 year ago

0.3.0-dev.121

1 year ago

0.3.0-dev.126

1 year ago

0.3.0-dev.127

1 year ago

0.3.0-dev.124

1 year ago

0.3.0-dev.125

1 year ago

1.0.0

1 year ago