Support for api-blueprint
Open
Nobody has claimed this yet.
feature request
- Dominant language
- Ruby
- Stars
- 10k
- Forks
- 1.2k
- Avg merge
- 14h 38m
- Merged PRs (30d)
- 92
Description
Hello there, ( sorry for the initial empty issue, writing now. )
There seems to be movement towards standardizing API descriptions in the form of apiblueprint as a human readable markdown endpoint. It would be nice to be able to have other tools deal with showing the routing & API documentation so that they don't have to be maintained in-house.
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
The issue names no files, tests, or entry points. Start by reviewing Grape's existing routing and API documentation alongside the linked API Blueprint specification; done would require a defined way for Grape APIs to produce or support API Blueprint descriptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100