1
0
Fork 0

Merge Router docs into Routing docs

This commit is contained in:
Alan Plum 2016-05-20 16:35:52 +02:00
parent 45ca89b1b2
commit 09b59f0d07
No known key found for this signature in database
GPG Key ID: 8ED72A9A323B6EFD
3 changed files with 70 additions and 79 deletions

View File

@ -1,4 +1,4 @@
!CHAPTER Router Module
!CHAPTER Routers
`const createRouter = require('@arangodb/foxx/router');`
@ -6,6 +6,74 @@ TODO
Routers need to be mounted to expose their HTTP routes. See [service context][CONTEXT].
!SECTION Creating a router
`createRouter(): Router`
This returns a new, clean Router object that has not yet been mounted in the service and can be exported like any other object.
!SECTION Request handlers
`router.get([path], handler, [name]): Endpoint`
`router.post([path], handler, [name]): Endpoint`
`router.put([path], handler, [name]): Endpoint`
`router.patch([path], handler, [name]): Endpoint`
`router.delete([path], handler, [name]): Endpoint`
`router.all([path], handler, [name]): Endpoint`
TODO
**Arguments**
* **path**: `string` (Default: `"/"`)
The path of the request handler relative to the base path the Router is mounted at. If omitted, the request handler will handle requests to the base path of the Router. For information on defining dynamic routes see the section on path parameters in the [chapter on router endpoints][ENDPOINTS].
* **handler**: `Function`
A function that takes the following arguments:
* **req**: `Request`
An incoming server request object.
* **res**: `Response`
An outgoing server response.
* **name**: `string` (optional)
A name that can be used to generate URLs for the endpoint. For more information see the `reverse` method of the [request object][REQUEST].
TODO
!SECTION Mounting child routers and middleware
`router.use([path], handler, [name]): Endpoint`
TODO
**Arguments**
* **path**: `string` (optional)
TODO
* **handler**: `Router | Middleware`
TODO
* **name**: `string` (optional)
A name that can be used to generate URLs for endpoints of this router. For more information see the `reverse` method of the [request object][REQUEST]. Has no effect if *handler* is a Middleware.
TODO
[CONTEXT]: ../Context.md
[ENDPOINTS]: ./Endpoints.md
[REQUEST]: ./Request.md

View File

@ -1,76 +0,0 @@
!CHAPTER Routers
`const createRouter = require('@arangodb/foxx/router');`
TODO
!SECTION Creating a router
`createRouter(): Router`
This returns a new, clean Router object that has not yet been mounted in the service and can be exported like any other object.
!SECTION Request handlers
`router.get([path], handler, [name]): Endpoint`
`router.post([path], handler, [name]): Endpoint`
`router.put([path], handler, [name]): Endpoint`
`router.patch([path], handler, [name]): Endpoint`
`router.delete([path], handler, [name]): Endpoint`
`router.all([path], handler, [name]): Endpoint`
TODO
**Arguments**
* **path**: `string` (Default: `"/"`)
The path of the request handler relative to the base path the Router is mounted at. If omitted, the request handler will handle requests to the base path of the Router. For information on defining dynamic routes see the section on path parameters in the [chapter on router endpoints][ENDPOINTS].
* **handler**: `Function`
A function that takes the following arguments:
* **req**: `Request`
An incoming server request object.
* **res**: `Response`
An outgoing server response.
* **name**: `string` (optional)
A name that can be used to generate URLs for the endpoint. For more information see the `reverse` method of the [request object][REQUEST].
TODO
!SECTION Mounting child routers and middleware
`router.use([path], handler, [name]): Endpoint`
TODO
**Arguments**
* **path**: `string` (optional)
TODO
* **handler**: `Router | Middleware`
TODO
* **name**: `string` (optional)
A name that can be used to generate URLs for endpoints of this router. For more information see the `reverse` method of the [request object][REQUEST]. Has no effect if *handler* is a Middleware.
TODO
[ENDPOINTS]: ./Endpoints.md
[REQUEST]: ./Request.md

View File

@ -67,8 +67,7 @@
* [Service context](Foxx/Context.md)
* [Configuration](Foxx/Configuration.md)
* [Dependencies](Foxx/Dependencies.md)
* [Routing](Foxx/Router/README.md)
* [Routers](Foxx/Router/Routers.md)
* [Routers](Foxx/Router/README.md)
* [Endpoints](Foxx/Router/Endpoints.md)
* [Middleware](Foxx/Router/Middleware.md)
* [Request](Foxx/Router/Request.md)