Skip to content

Commit 132dbc3

Browse files
docs: fix roadmap todo
1 parent 6cb89d0 commit 132dbc3

1 file changed

Lines changed: 14 additions & 8 deletions

File tree

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,39 @@
33
Code generator that ingest a OpenAPI Specification and writes the structs that represent resources of that given specification and also builds the client based on the paths.
44

55
Currently supports two types of generation:
6-
* Tesla - Generates a module with a Tesla client
7-
* Req - Generates a module using Req
6+
7+
* [Tesla](https://hexdocs.pm/tesla/readme.html) - Generates a module with a Tesla client.
8+
* [Req](https://hexdocs.pm/req/readme.html) - Generates a module using Req.
89

910
By default we're using Jason for encoding and decoding of strucs
1011

1112
Does not require you to install extra dependencies as we're using
1213

1314
## Roadmap
14-
[] - Support XML specification parsing
15-
[] - Support Inheritance and Polymorphism
16-
[] - Add typespecs to generated Strucs
17-
[] - Add typespecs to Client
18-
[] - Generate tests for Client
15+
16+
- [] Support YAML specification parsing
17+
- [] Support Inheritance and Polymorphism
18+
- [] Add typespecs to generated Strucs
19+
- [] Add typespecs to Client
20+
- [] Generate tests for Client
1921

2022
## Installation
23+
2124
Install it using:
22-
```
25+
26+
```sh
2327
mix do local.rebar --force, local.hex --force
2428
mix escript.install hex openapi_codegen
2529
```
2630

2731
## Usage
2832

2933
Generating a Tesla client using PetStore example:
34+
3035
`openapi_codegen --tesla --output-path lib openapi_petstore.json`
3136

3237
Generating a Req client using PetStore example:
38+
3339
`openapi_codegen --req --output-path lib openapi_petstore.json`
3440

3541
This examples will generate your code in your folder `lib` and also create a `lib/components` with all the structs.

0 commit comments

Comments
 (0)