Redocly/create-openapi-repo

[Question] Editor/plugin with support for embedding external markdown

austpaul opened this issue · 1 comments

"Write it using your favorite text-editor or IDE (we love VSCode)."

Which plugin do you use when editing an openAPI repo? For large project and multiple contributions, externalizing the markdown makes a lot of sense.
I'm currently using the OpenAPI (Swagger) Editor (42crunch.vscode-openapi) with the Redoc rendering setting. This crashes when adding references to external markdown files.

Do you have any preferred workflow and toolset that doesn't involve a lot of copy/pasting and commenting out the API definition while working with the openapi-repo structure?

I was wondering about the same. I was using Stoplight Studio, cause that's quite amazing and free, but openapi-cli does some opinionated proprietary splitting which other tools do not consume.

However, you can do with VS Code + these two extensions:
https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi
https://marketplace.visualstudio.com/items?itemName=proohit.openapi-snippets