Skip to content

Commit cf628ed

Browse files
author
Jerome Louvel
committed
Update README.md
1 parent 8c53008 commit cf628ed

1 file changed

Lines changed: 5 additions & 7 deletions

File tree

modules/org.restlet.tutorial.webapi/README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,15 @@ To simplify the launch of the application, authentication and authorization are
4343

4444
It uses HTTP Basic authentication. Learn more about authentication, authorization and security with Restlet Framework [here](http://restlet.com/learn/guide/2.3/core/security/).
4545

46-
You can try this application easily with a REST client like [POSTMAN](http://www.getpostman.com/).
46+
You can interact with this application easily using a REST client like [POSTMAN](http://www.getpostman.com/).
4747

4848
## Database access
4949

5050
To visualize the database, open the H2 console in you browser (`http://localhost:8082`) and connect to the database with the JDBC URL `jdbc:h2:mem:restletWebApi;IFEXISTS=TRUE`.
5151

5252
## Description
5353

54-
This Web API contains 2 main resources :
54+
This Web API contains 2 main resources:
5555
* Company : identified by an auto-generated id.
5656
* Contact : identified by its email. A contact can be part of a company and get a reference to it.
5757

@@ -97,7 +97,7 @@ A resource `/ping` has been created which does not need authentication.
9797

9898
It should return the ```Version: 1.0.0 running``` text in the HTTP response body.
9999

100-
For the following examples, Basic Authentication is required.
100+
For the following examples, Basic Authentication is required. Also, you should indicate the media type of the JSON document sent using a ```Content-Type: application/json``` HTTP header.
101101

102102
### Create a company
103103

@@ -116,15 +116,13 @@ For the following examples, Basic Authentication is required.
116116
}
117117
```
118118

119-
The returned status is : `201 Created`. Note that the location of the created company is written is the "Location" HTTP header.
119+
The returned status is : `201 Created`. Note that the location of the created company is written is the ```Location``` HTTP header.
120120

121121
### Retrieve all created companies
122122

123123
```GET http://localhost:9000/v1/companies/```
124124

125-
> The trailing slash is optional : both `http://localhost:9000/v1/companies/` and `http://localhost:9000/v1/companies` will work.
126-
127-
It should retrieve :
125+
The trailing slash is optional : both `http://localhost:9000/v1/companies/` and `http://localhost:9000/v1/companies` will work. It should retrieve :
128126

129127
```json
130128
{

0 commit comments

Comments
 (0)