Skip to content

Commit 337f72c

Browse files
authored
Update README.md
1 parent 996e892 commit 337f72c

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,15 @@
22

33
[![Build Status](https://travis-ci.org/tminglei/binder-swagger-java.svg?branch=master)](https://travis-ci.org/tminglei/binder-swagger-java)
44

5-
I noticed, if we provided the `swagger.json`, [`swagger ui`](http://petstore.swagger.io/) will take care of the others: dynamically build the web client, enable us online browsing the APIs, sending request to and receiving response from the real services.
5+
`binder-swagger-java` is a simple api management solution, which let api maintainence and dev based on api easily.
66

7-
`binder-swagger-java` was designed to help construct the swagger object (corresponding to `swagger.json`), and let it accessible from swagger ui or other http visitors.
7+
8+
## Features
9+
- lightweight, less then 3000 line codes (framework + built-in route/fake data generating)
10+
- based on `form-binder-java`, allowing dynamic objects in operation's parameter/response definitions
11+
- directly integrate with `swagger-models`, allowing to operate swagger object when necessary
12+
- can generate mock response w/ fake data on demand for unimplemented api operations
13+
- high customizable, you can replace almost all of the core components
814

915

1016
## How it works
@@ -15,13 +21,13 @@ You define the api meta data in classes' static code blocks, then it was collect
1521
> _p.s. `binder-swagger-java` based on [`form-binder-java`](https://github.com/tminglei/form-binder-java) and [`swagger-models`](https://github.com/swagger-api/swagger-core), allow to define dynamic data structures and operate the swagger object directly when necessary, so it's more expressive in theory._
1622
1723

18-
## How to use
24+
## How to use it
1925
#### 0) add the dependency to your project:
2026
```xml
2127
<dependency>
2228
<groupId>com.github.tminglei</groupId>
2329
<artifactId>binder-swagger-java</artifactId>
24-
<version>0.6.2</version>
30+
<version>0.8.0</version>
2531
</dependency>
2632
```
2733
#### 1) define and register your api operations:

0 commit comments

Comments
 (0)