API Documentation - Swagger | Voters

Docusaurus

Create

Roadmap

Feature Requests

API Documentation - Swagger

Lespagnol Rémy

The possibility to add a swagger documentation into Docusaurus

May 2, 2019

Andreas Taube

@Johannes Ferner how did you manage to isolate the classic-theme stylings to not interfere with the redoc styles?

Johannes Ferner

@Andreas Taube: some manual quick&dirty overrides - it wasn't too much.

Andreas Taube

@Johannes Ferner: I see, thanks for the feedback, I finally created 2 sides behind an nginx to solve this for now. The only annoying thing is the react router intercepting relative paths. I solved this with the target attribute.

Johannes Ferner

We have actually integrated redoc on https://developer.fiskaly.com/api/kassensichv

Should be possible with Swagger as well (if there is a react component of it)

        <RedocStandalone
          specUrl='https://kassensichv.io/api/spec'
          options={{
            requiredPropsFirst: true,
            noAutoAuth: true,
            hideDownloadButton: true,
            onlyRequiredInSamples: true,
            nativeScrollbars: true,
            scrollYOffset: 60,
            theme: { colors: { primary: { main: '#2da8d3' } } },
          } }
        />

We're still working on rendering it statically soon.

Until then it spawns a reDoc standalone

Edgar Silva

@Johannes Ferner: Hi could you explain a bit how you did it?

Enrique Ojeda Lara

This would be a a very nice and great frature

Endilie Yacop Sucipto

The possibility is there. Now we can handle different data sources, just need a plugin for it. It can be python files, .rst files, JSON, etc.

Lespagnol Rémy

@Endilie Yacop Sucipto: With docusaurus 2.0 ? :)

Endilie Yacop Sucipto

@Lespagnol Rémy: yes.

Jeremie Poutrin

@Endilie Yacop Sucipto: You mean someone needs to write the plugin, correct?

Michael Wood

This would be really great.