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.

Sign up for GitHub

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

Jump to bottom

Add swagger api document #292

Closed
narrowizard opened this issue Aug 26, 2021 · 6 comments
Closed

Add swagger api document #292

narrowizard opened this issue Aug 26, 2021 · 6 comments
Labels
good first issue Good for newcomers type/feature-request This issue is a proposal for something new

Comments

@narrowizard
Copy link
Collaborator

narrowizard commented Aug 26, 2021 •
edited
Loading

Description

We should add document for restful api.

Describe the solution you'd like

Recomended to use swagger with a lot great features and extensions, for example:

  • generator documents from code with swaggo
  • auto resolve apis with gin-swagger
  • an easy-use web UI
    image
  • try out apis from web UI
    image
@narrowizard narrowizard added the type/feature-request This issue is a proposal for something new label Aug 26, 2021
@narrowizard narrowizard self-assigned this Aug 26, 2021
@narrowizard
Copy link
Collaborator Author

/cc @joncodo @hezyin @klesh

@narrowizard narrowizard mentioned this issue Aug 26, 2021
Closed
2 tasks
@joncodo joncodo reopened this Dec 8, 2021
@joncodo joncodo assigned joncodo and unassigned narrowizard Dec 8, 2021
@joncodo joncodo changed the title Add api document Add swagger api document Dec 8, 2021
@joncodo joncodo added the good first issue Good for newcomers label Dec 14, 2021
@joncodo joncodo removed their assignment Jan 10, 2022
@xgdyp
Copy link
Contributor

xgdyp commented May 12, 2022

I'll pick it！

@xgdyp
Copy link
Contributor

xgdyp commented May 13, 2022

I noticed the PR before was closed. Should I use go-swagger or just write down the docs?

@klesh
Copy link
Contributor

klesh commented May 16, 2022

Just a note: as we discussed on IM the other day, it was closed due to some implementation issues. We need this sooner or later.
We should try to accomplish the following targets regarding implementation:

  1. Can swagger server run along side api server? AKA, under different path but same port?
  2. Can document be generated automatically from the source code, not a separated json file?
  3. Can we call api directly from swagger doc?

@xgdyp
Copy link
Contributor

xgdyp commented May 16, 2022

Thanks for your note. I think ginswagger can match all the requirements. Now I have used this framework in project and I'm setting other parameters.

@xgdyp xgdyp mentioned this issue May 17, 2022
Merged
2 tasks
@warren830
Copy link
Contributor

fixed by #1900

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers type/feature-request This issue is a proposal for something new
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@klesh @joncodo @narrowizard @xgdyp @warren830