Skip to content

Commit a6d294e

Browse files
committed
doc updates
1 parent 1070337 commit a6d294e

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,28 @@ Sample application with full CRUD for Airport codes to showcase following techno
1212

1313
Setup
1414
-----
15-
- Use your favorite IDE to deploy and run.
16-
- Use maven command to deploy to Tomcat.
15+
- Use your favorite IDE to deploy and run the application.
16+
- Use maven command to deploy to Tomcat. NOTE: maven settings.xml need to be configured with your local server.
1717
```bash
1818
$ mvn tomcat7:deploy
1919
```
20-
- Access sample application in browser using url:
20+
21+
Access
22+
------
23+
- via browser using url:
2124
```
2225
http://localhost:8080/sample
2326
```
24-
or in REST client using url:
25-
```
26-
http://localhost:8080/sample/api/airpots
27+
![Alt text](/sample.png?raw=true "Optional Title")
28+
29+
- via REST client using url:
30+
```html
31+
GET http://localhost:8080/sample/api/airpots
32+
GET http://localhost:8080/sample/api/airpots/123 (using id)
33+
GET http://localhost:8080/sample/api/airpots/NYC (using code)
34+
GET http://localhost:8080/sample/api/airpots/search/Wash (using text)
35+
POST http://localhost:8080/sample/api/airpots
36+
PUT http://localhost:8080/sample/api/airpots
37+
DELETE http://localhost:8080/sample/api/airpots/123 (using id)
2738
```
39+

0 commit comments

Comments
 (0)