Update README.md

Author: tminglei

README.md

@@ -25,35 +25,37 @@ You define the api meta data in classes' static code blocks, then it was collect
 #### 0) add the dependency to your project:
 ```xml
 <dependency>
-  <groupId>com.github.tminglei</groupId>
-  <artifactId>binder-swagger-java</artifactId>
-  <version>0.8.0</version>
+    <groupId>com.github.tminglei</groupId>
+    <artifactId>binder-swagger-java</artifactId>
+    <version>0.8.0</version>
 </dependency>
 ```
 #### 1) define and register your api operations:
 ```java
 // in `PetResource.java`
 static Mapping<?> petStatus = $(text(oneOf(Arrays.asList("available", "pending", "sold"))))
-    .desc("pet status in the store").$$;
+    .desc("pet status in the store").example("available").$$;
 static Mapping<?> pet = $(mapping(
-    field("id", $(vLong()).desc("pet id").$$),
+    field("id", $(vLong()).desc("pet id").example(gen("petId").or(gen(() -> new Faker().number().randomNumber()))).$$),
     field("name", $(text(required())).desc("pet name").$$),
     field("category", attach(required()).to($(mapping(
-            field("id", vLong(required())),
-            field("name", text(required()))
+          field("id", vLong(required())),
+          field("name", text(required()))
     )).refName("category").desc("category belonged to").$$)),
-    field("photoUrls", $(list(text())).desc("pet's photo urls").$$),
-    field("tags", $(list(text())).desc("tags for the pet").$$),
+    field("photoUrls", $(list(text())).desc("pet's photo urls").example(Arrays.asList("http://example.com/photo1")).$$),
+    field("tags", $(list(text())).desc("tags for the pet").example(Arrays.asList("tag1", "tag2")).$$),
     field("status", petStatus)
 )).refName("pet").desc("pet info").$$;
 
+static SharingHolder sharing = sharing().pathPrefix("/pet").tag("pet");
+
 static {
-    operation("post", "/pet")
-        .summary("create a pet")
-        .tag("pet")
-        .parameter(param(pet).in("body"))
-        .response(200, response().description("success"))
-        .response(400, response())
+    sharing.operation(GET, "/:petId<[0-9]+>")
+        .summary("get pet by id")
+        .parameter(param(longv()).in("path").name("petId").example(1l))
+        .response(200, response(pet))
+        .response(404, response().description("pet not found"))
+        .notImplemented() // MARK IT `notImplemented`, THEN `binder-swagger-java` WILL GENERATE MOCK RESPONSE FOR YOU
     ;
 }
 @POST
@@ -64,31 +66,31 @@ public Response addPet(String data) throws BadRequestException, SQLException {
 ```java
 // in `Bootstrap.java`
 static {  // for swagger
-	swagger().info(info()
-	      .title("Swagger Sample App")
-	      .description("This is a sample server Petstore server.  You can find out more about Swagger " +
-		      "at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).  For this sample, " +
-		      "you can use the api key `special-key` to test the authorization filters.")
-	      .termsOfService("http://swagger.io/terms/")
-	      .contact(contact().email("apiteam@swagger.io"))
-	      .license(license().name("Apache 2.0")
-		              .url("http://www.apache.org/licenses/LICENSE-2.0.html")
-	      )
-	).host("localhost:8002")
-	.basePath("/api")
-	.consumes("application/json")
-	.produces("application/json")
-	.securityDefinition("api_key", apiKeyAuth("api_key", In.HEADER))
-	.securityDefinition("petstore_auth", oAuth2()
-		      .implicit("http://petstore.swagger.io/api/oauth/dialog")
-		      .scope("read:pets", "read your pets")
-		      .scope("write:pets", "modify pets in your account")
-	).tag(tag("pet").description("Everything about your Pets")
-		      .externalDocs(externalDocs().description("Find out more").url("http://swagger.io"))
-	).tag(tag("store").description("Access to Petstore orders")
-	).tag(tag("user").description("Operations about user")
-	      .externalDocs(externalDocs().description("Find out more about our store").url("http://swagger.io"))
-	);
+    swagger().info(info()
+        .title("Swagger Sample App")
+        .description("This is a sample server Petstore server.  You can find out more about Swagger " +
+              "at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).  For this sample, " +
+              "you can use the api key `special-key` to test the authorization filters.")
+        .termsOfService("http://swagger.io/terms/")
+        .contact(contact().email("apiteam@swagger.io"))
+        .license(license().name("Apache 2.0")
+              .url("http://www.apache.org/licenses/LICENSE-2.0.html")
+        )
+    ).host("localhost:8002")
+    .basePath("/api")
+    .consumes("application/json")
+    .produces("application/json")
+    .securityDefinition("api_key", apiKeyAuth("api_key", In.HEADER))
+    .securityDefinition("petstore_auth", oAuth2()
+          .implicit("http://petstore.swagger.io/api/oauth/dialog")
+          .scope("read:pets", "read your pets")
+          .scope("write:pets", "modify pets in your account")
+    ).tag(tag("pet").description("Everything about your Pets")
+          .externalDocs(externalDocs().description("Find out more").url("http://swagger.io"))
+    ).tag(tag("store").description("Access to Petstore orders")
+    ).tag(tag("user").description("Operations about user")
+          .externalDocs(externalDocs().description("Find out more about our store").url("http://swagger.io"))
+    );
 }
 ```
 #### 3) configure the filter, which will serv the `swagger.json`: