API reference look and feel

[DebbieAtSeam]

Looking for a way to style part of a GitBook site as a modern API reference--with code samples in a right-hand column on the page. The GitBook OpenAPI widget is not an option for us in its current form. I see https://github.com/GitbookIO/theme-api, but its most recent commit seems to be many years ago. Is this plugin still maintained, or is there a more recent way to accomplish the same thing? Thanks!

[nolannbiron]

Hi @DebbieAtSeam, thanks for reaching out to us!

Would you mind sharing why the OpenAPI widget doesn’t work for your use case ?

The theme-api plugin you mentioned is an older resource and is no longer actively maintained

[DebbieAtSeam]

The OpenAPI widget displays JS and other language code samples that are incorrect for our API.

[nolannbiron]

Thanks for the clarification.

You can provide your own code samples using x-codeSamples at operation level. It’s documented here

Don’t hesitate to reach out if you have any issues setting this up!

[DebbieAtSeam]

Thanks!