thim81 / thim81/openapi-format
Format: Generate example/examples using Faker or AI LLM
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 177
- Forks
- 29
- Avg merge
- 3d 13h
- Merged PRs (30d)
- 1
Description
use-case for better documentation, it is always advised to have "example" values per property and if possible "examples"
These are usefull for the consumers/users for your API, since they provide inline context and can be useful to provide context.
The example data generation could use:
- Faker to generate some random data
OR
- we could plugin an LLM to generate the example/examples based on the OpenAPI context.
Ideas:
Contributor guide
No contributing guide indexed for this repository
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 proposes generating OpenAPI example values with Faker or an LLM, but it does not identify files, tests, or an entry point. First compare the two proposed approaches and define the supported OpenAPI context and generated output. Done should mean that properties receive useful example values or examples, with tests covering the selected behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100