Skip to content

Commit c0eaa81

Browse files
committed
[README] add links to doc
1 parent 3d7c5b4 commit c0eaa81

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The package come with 2 modules:
2828

2929
### Building a request
3030

31-
You make requests by creating `Request` objects. You can either create them manually or provide static definition by extending `Request`:
31+
You make requests by creating [`Request`](https://pjechris.github.io/SimpleHTTP/Structs/Request.html) objects. You can either create them manually or provide static definition by extending `Request`:
3232

3333
```swift
3434
extension Request {
@@ -44,7 +44,7 @@ This defines a `Request.login(_:)` method which create a request targeting "logi
4444

4545
You can use your request along `URLSession` by converting it into a `URLRequest` by calling `request.toURLRequest(encoder:relativeTo:accepting)`.
4646

47-
You can also use a `Session` object. `Session` is somewhat similar to `URLSession` but providing additional functionalities:
47+
You can also use a `Session` object. [`Session`](https://pjechris.github.io/SimpleHTTP/Classes/Session.html) is somewhat similar to `URLSession` but providing additional functionalities:
4848

4949
- encoder/decoder for all requests
5050
- error handling
@@ -91,7 +91,7 @@ extension Request {
9191

9292
### Multipart
9393

94-
You can create multipart content from two kind of content
94+
You can create [multipart](https://pjechris.github.io/SimpleHTTP/Structs/MultipartFormData.html) content from two kind of content
9595

9696
- From a disk file (using a `URL`)
9797
- From raw content (using `Data`)
@@ -160,14 +160,14 @@ When using Session you can add automatic behavior to your requests/responses usi
160160

161161
### `RequestInterceptor`
162162

163-
`RequestInterceptor` allows to adapt and/or retry a request:
163+
[`RequestInterceptor`](https://pjechris.github.io/SimpleHTTP/Protocols/RequestInterceptor.html) allows to adapt and/or retry a request:
164164

165165
- `adaptRequest` method is called before making a request allowing you to transform it adding headers, changing path, ...
166166
- `rescueRequestError` is called whenever the request fail. You'll have a chance to retry the request. This can be used to re-authenticate the user for instance
167167

168168
### `ResponseInterceptor`
169169

170-
`ResponseInterceptor` is dedicated to intercept and server responses:
170+
[`ResponseInterceptor`](https://pjechris.github.io/SimpleHTTP/Protocols/ResponseInterceptor.html) is dedicated to intercept and server responses:
171171

172172
- `adaptResponse` change the server output
173173
- `receivedResponse` notify about the server final response (a valid output or error)

0 commit comments

Comments
 (0)