ruby-grape / ruby-grape/grape-swagger

Best way to host the swagger-ui in grape

Open
#109 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

needs help new feature swagger-1.2
Dominant language
Ruby
Stars
1.1k
Forks
479
Avg merge
2d 14h
Merged PRs (30d)
6

Description

Is there a minimal example for using swagger+grape+adding a route to show a UI?.

It would be great to host the UI along with the grape-swagger part, so I can just point users to a url and have the documentation all there.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by reviewing the existing grape-swagger documentation and integration examples, then determine how Swagger UI can be hosted at a user-facing URL alongside the generated API documentation. Done means documenting a minimal working example for grape, swagger, and the UI.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.