Skip to content

Commit

Permalink
chore: improve the the pub.dev points
Browse files Browse the repository at this point in the history
  • Loading branch information
SuicaLondon committed Jun 9, 2024
1 parent a991201 commit 766ad25
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 2 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 1.0.2

- Improved pub points

## 1.0.1

- Restructure the structure
Expand Down
19 changes: 19 additions & 0 deletions example/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Generate Swagger Endpoints

If you are using **Flutter** with **Swagger**, you may be annoyed that no library allows you to build models and endpoints flexibly. For example, a popular library called [swagger_dart_code_generator](https://pub.dev/packages/swagger_dart_code_generator) includes most functionality, but it is not flexible at all. It strictly binds the [Chopper](https://pub.dev/packages/chopper), if you don't want to use another client library like [Dio](https://pub.dev/packages/dio), you can only generate data models without any endpoint. That is a library I built for my freelance projects and company projects to quickly solve these issues of [swagger_dart_code_generator](https://pub.dev/packages/swagger_dart_code_generator). I saw my friend also face this issue on his company's new project. ~~So he should treat me a Big Mac now~~

This project is still very simple and I am busy on another thing right now, please leave your feedback on the issues or the requirements on the issues.

## Install

```Bash
dart pub global activate generate_swagger_endpoint
```

### How to use

```Bash
dart pub global run generate_swagger_endpoint --input ./lib/api/swagger -output ./lib/api/endpoints/

dart pub global run generate_swagger_endpoint --input ./lib/api/swagger -output ./lib/api/endpoints/
```
5 changes: 3 additions & 2 deletions pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
name: generate_swagger_endpoint
owner: suica.dev
description: A command-line to extract endpoint from swagger.json.
description: This command-line tool extracts endpoints from a swagger.json file. It generates a class containing the endpoints as static properties.
repository: https://github.com/SuicaLondon/generate_swagger_endpoint
homepage: https://pub.dev/packages/generate_swagger_endpoint
version: 1.0.1
version: 1.0.2
# repository: https://github.com/my_org/my_repo

environment:
Expand Down

0 comments on commit 766ad25

Please sign in to comment.