retrofit_cli

Description:

retrofit cli

retrofit_cli #
Dart Retrofit API Generator (🚧 under
construction 🚧)
Install #
dart pub global activate retrofit_cli
copied to clipboard
Install from source
dart pub global activate --source=git https://github.com/luiscib3r/retrofit_cli.git
copied to clipboard
or
git clone https://github.com/luiscib3r/retrofit_cli.git
cd retrofit_cli
make install
copied to clipboard
Usage #
1. Define your api using a yaml file
Example of api.yaml
name: Todos
endpoints:
- name: getTodos
method: GET
url: /todos
params:
- name: String
- description: String
- count: int
response: |
[
{
"id": "idstring",
"name": "todo name",
"description": "todo description",
"price": 2.5,
"count": 3
}
]
- name: getTodo
method: GET
url: /todos/{id}
paths:
- id: String
response: |
{
"id": "idstring",
"name": "todo name",
"description": "todo description",
"price": 2.5,
"count": 3
}
- name: saveTodo
method: POST
url: /todos
headers:
- Authorization
payload: |
{
"name": "todo name",
"description": "todo description"
}
response: |
{
"id": "idstring",
"name": "todo",
"description": "desc1",
"price": 0.0,
"count": 0
}
- name: updateTodo
method: PUT
url: /todos/{id}
headers:
- Authorization
paths:
- id: String
payload: |
{
"name": "new todo name",
"description": "new todo description"
}
response: |
{
"id": "idstring",
"name": "new todo name",
"description": "new todo description"
}
- name: deleteTodo
method: DELETE
url: /todos/{id}
headers:
- Authorization
paths:
- id: String
response: |
{}
copied to clipboard
2. Generate api package using retrofit_cli
Default
retrofit_cli api
copied to clipboard
Set output package folder (default is api)
retrofit_cli api -o api_package_name
copied to clipboard
Set input .yaml file (default is api.yaml)
retrofit_cli api -o api_package_name -i my_api.yaml
copied to clipboard