ruby-grape / ruby-grape/grape-swagger
External API
Open
Nobody has claimed this yet.
new feature
swagger-1.2
- Dominant language
- Ruby
- Stars
- 1.1k
- Forks
- 479
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 6
Description
How I can add an external API documentation?
For example, I'm using doorkeeper, POST /api/v1/token
That's not a grape endpoint. How can I add this endpoint into swagger ?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing how grape-swagger discovers Grape endpoints and whether it has an extension point for routes outside Grape. Use the example POST /api/v1/token endpoint from Doorkeeper to clarify the expected representation, then identify tests or documentation that would define support as complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100