Feature: interactive swagger-ui auto-generated API docs from express #1812
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ocflowiseai
changed the title
ocflowiseai
force-pushed
the
feature/swagger-api-interactive-documentation
branch
from
291b394 to
3fbbc6c
Compare
|
|
Closed
patrickreinan
pushed a commit
to patrickreinan/Flowise
that referenced
this pull request
Sep 3, 2024
…lowiseAI#1812) * Add interactive swagger-ui auto-generated API docs from express * Update README.md * Update index.ts //@ts-ignore * Fix eslint no-console error * Add swagger paths * Add all end points * Update swagger.yml * update swagger yml file * update swagger config --------- Co-authored-by: Henry <[email protected]>
patrickreinan
pushed a commit
to patrickreinan/Flowise
that referenced
this pull request
Sep 3, 2024
…lowiseAI#1812) * Add interactive swagger-ui auto-generated API docs from express * Update README.md * Update index.ts //@ts-ignore * Fix eslint no-console error * Add swagger paths * Add all end points * Update swagger.yml * update swagger yml file * update swagger config --------- Co-authored-by: Henry <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This module serves auto-generated swagger-ui API docs from express, based on a swagger.yml file.
This module works only when running Flowise in dev mode with
yarn devcommand either from root folder either frompackages/api-documentationfolder.The result is interactive swagger documentation for Flowise API served via http://localhost:6655/api-docs route.
Methods to be added as described here - https://editor.swagger.io/