OpenAPITools / OpenAPITools/openapi-generator
[REQ] Example use of generated client
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
I have no idea how to use generated ApiClient class which is defined in infrastructure package (in kotlin generator). Or should I use *Api classes directly in apis package. How to configure base path, etc.
Is that generated architecture documented somewhere? Because the output looks almost same in every generator. Simple "Hello World" example would be nice starting point.
Now I have to reverse-engineer generated code and after many trials and errors I got simplest request working.
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 with the generated ApiClient in the Kotlin generator's infrastructure package and the *Api classes in the apis package. Document how the generated architecture is intended to be used, including base-path configuration, and provide a simple Hello World request example; done means a newcomer can use the generated client without reverse-engineering it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kotlin, openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100