Major updates to API documentation 🤖

[addisonschultz]

Hello everyone! We're thrilled to announce a major upgrade to GitBook focused entirely on API documentation! 🤖 ☁️

Here’s some of the stuff we’ve just launched:

Auto-generated API docs

We've launched powerful features that make documenting and managing your APIs seamless. With auto-generated API docs directly from your OpenAPI specs, your documentation is always accurate and up-to-date—no manual updates required!

From the main GitBook app, head to the OpenAPI tab in the sidebar to get started.

Interactive and customizable - In all new ways.

Explore our interactive endpoint testing feature, allowing users to test API endpoints directly from your docs. Plus, create highly customizable API route pages—tailor the appearance and structure exactly how you want it.

OpenAPI spec management

Managing and updating your OpenAPI specs has never been easier. Instantly synchronize your API changes and keep your documentation perfectly aligned with your development process.

We’ve also updated our CLI to help you manage your OpenAPI spec without having to open the app. Read the docs on the CLI here.

---

Make sure you head to the docs to read up on everything that’s new: https://docs.gitbook.com/api-references/openapi

We’d love to hear your feedback on these updates—check them out now in your GitBook space!

Enjoy the new features, and let us know what you think!

Addison + the GitBook team

[kfc2023]

it seems i have to manually migrate each existing block. is that correct?

[addisonschultz]

You should be able to automatically generate your API routes/pages after uploading an OpenAPI spec - https://docs.gitbook.com/api-references/openapi/insert-api-reference-in-your-docs#automatically-create-openapi-pages-from-your-spec

Are you not seeing this option?

[kfc2023]

my mgmt wants the endpoints grouped a certain way, regardless of the order in the spec, so that option doesn't help me. https://gitbook.idevit.us/corastone-docs/01Q6WWC87qx0YR4SVaVh/latest-integration-api-guide/libraries

…

On Tue, Apr 22, 2025 at 7:09 PM Addison ***@***.***> wrote: You should be able to automatically generate your API routes/pages after uploading an OpenAPI spec - https://docs.gitbook.com/api-references/openapi/insert-api-reference-in-your-docs#automatically-create-openapi-pages-from-your-spec Are you not seeing this option? — Reply to this email directly, view it on GitHub <#948 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A6F7GSMGKNDYLUAFCBSVPXL223Y5XAVCNFSM6AAAAAB3TWD6XCVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTEOJRG4YDKNA> . You are receiving this because you commented.Message ID: ***@***.***>

[addisonschultz]

It still is possible to maintain the structure you’re looking for - you’ll need to set up a few extra properties in your OpenAPI spec that will allow it to generate as intended: https://docs.gitbook.com/api-references/guides/structuring-your-api-reference#nest-pages-into-groups

[kfc2023]

i don't control the spec. looks like the answer is yes, i need to migrate each block once.

…

On Tue, Apr 22, 2025 at 7:20 PM Addison ***@***.***> wrote: It still is possible to maintain the structure you’re looking for - you’ll need to set up a few extra properties in your OpenAPI spec that will allow it to generate as intended: https://docs.gitbook.com/api-references/guides/structuring-your-api-reference#nest-pages-into-groups — Reply to this email directly, view it on GitHub <#948 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A6F7GSMVJ2HT3ZRODMFHGPT2232F5AVCNFSM6AAAAAB3TWD6XCVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTEOJRG4YTENQ> . You are receiving this because you commented.Message ID: ***@***.***>

[zackAJ]

hello @addisonschultz .
I'm running into a bug when trying to publish a spec, it's not reading my spec arg ?

gitbook openapi publish --spec myRealSpecName --organization organization_id <path-or-url>

Caution

error: required option '-s, --spec ' not specified

[zackAJ]

this was happening because I was running gitbook via a custom script form package.json and npx, my bad.

    "scripts": {
        "dev": "vite",
        "build": "vite build",
        "gitbook": "gitbook"
    },