ruby-grape / ruby-grape/grape-swagger
Supporting i18n?
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
swagger spec doesn't natively support i18n, but is it possible that grape-swagger generate localized documents for different locale? For example, visiting http://localhost:3000/swagger_doc.json will get default language, as well as visiting http://localhost:3000/swagger_doc.json?locale=zh-CN will get another json in Chinese.
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
No files or tests are named. Start by locating the entry point that serves swagger_doc.json and reviewing how request locales and generated documentation are handled; done should mean a documented, tested approach for default and locale-specific JSON responses.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- api, documentation, internationalization
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100