Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new documentation tool: openAPI-UI #477

Merged
merged 5 commits into from
May 29, 2024

Conversation

rookie-luochao
Copy link
Contributor

Thanks for this project

This PR adds a new documentation tool that show api, it is simpler and more beautiful than swagger UI, it can quickly generate mock params and call api request

@AndrewWalsh AndrewWalsh self-assigned this May 29, 2024
Copy link
Collaborator

@AndrewWalsh AndrewWalsh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks really impressive, great work. Please inspect this review @rookie-luochao .

Two thoughts:

  • Would be great to see this in use instantly, with default OpenAPI specs on your main site (without users having to upload their own). That way, users can see what your UI/tool does and looks like without effort.
  • An English translation would be appreciated.

_data/tools.yml Outdated Show resolved Hide resolved
_data/tools.yml Outdated Show resolved Hide resolved
_data/tools.yml Outdated Show resolved Hide resolved
_data/tools.yml Show resolved Hide resolved
@rookie-luochao
Copy link
Contributor Author

rookie-luochao commented May 29, 2024

This looks really impressive, great work. Please inspect this review @rookie-luochao .

Two thoughts:

  • Would be great to see this in use instantly, with default OpenAPI specs on your main site (without users having to upload their own). That way, users can see what your UI/tool does and looks like without effort.
  • An English translation would be appreciated.
  • It provides multiple themes and i18n functions, supporting English
  • It supports backend framework access. I have already supported some golang frameworks and nodejs frameworks.
  • I provide a web page to quickly pre-render and use OpenAPI-UI, but it also supports web framework access through middleware

I don't know if your suggestion is the above two, Welcome to communicate

Co-authored-by: Andrew Walsh <15863952+AndrewWalsh@users.noreply.github.com>
Copy link

vercel bot commented May 29, 2024

@rookie-luochao is attempting to deploy a commit to the APIs You Won't Hate Team on Vercel.

A member of the Team first needs to authorize it.

Co-authored-by: Andrew Walsh <15863952+AndrewWalsh@users.noreply.github.com>
_data/tools.yml Outdated Show resolved Hide resolved
@AndrewWalsh
Copy link
Collaborator

AndrewWalsh commented May 29, 2024

This looks really impressive, great work. Please inspect this review @rookie-luochao .
Two thoughts:

  • Would be great to see this in use instantly, with default OpenAPI specs on your main site (without users having to upload their own). That way, users can see what your UI/tool does and looks like without effort.
  • An English translation would be appreciated.
* It provides multiple themes and i18n functions, supporting English

* It supports backend framework access. I have already supported some [golang frameworks](https://github.com/openapi-ui/go-openapi-ui) and [nodejs frameworks](https://github.com/openapi-ui/nodejs-openapi-ui).

* I provide a web page to quickly pre-render and use OpenAPI-UI, but it also supports web framework access through middleware

I don't know if your suggestion is the above two, Welcome to communicate

Everything I said in this regard is a suggestion, and I haven't delved into your tool enough to assess. It bears no relation to the review, so no worries!

Co-authored-by: Andrew Walsh <15863952+AndrewWalsh@users.noreply.github.com>
@rookie-luochao
Copy link
Contributor Author

Thank you for your suggestion

@rookie-luochao
Copy link
Contributor Author

Can this PR be merged?

@AndrewWalsh AndrewWalsh merged commit 8091e06 into apisyouwonthate:main May 29, 2024
1 check failed
@AndrewWalsh
Copy link
Collaborator

@rookie-luochao yes - thanks for your patience and congrats on your project 🎉

@rookie-luochao
Copy link
Contributor Author

I should be the one thanking you. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants