mirror of https://gitee.com/bigwinds/arangodb
39 lines
1.0 KiB
Markdown
39 lines
1.0 KiB
Markdown
<!-- don't edit here, its from https://@github.com/arangodb/arangodbjs.git / docs/Drivers/ -->
|
|
# Arbitrary HTTP routes
|
|
|
|
## database.route
|
|
|
|
`database.route([path,] [headers]): Route`
|
|
|
|
Returns a new _Route_ instance for the given path (relative to the database)
|
|
that can be used to perform arbitrary HTTP requests.
|
|
|
|
**Arguments**
|
|
|
|
* **path**: `string` (optional)
|
|
|
|
The database-relative URL of the route.
|
|
|
|
* **headers**: `Object` (optional)
|
|
|
|
Default headers that should be sent with each request to the route.
|
|
|
|
If _path_ is missing, the route will refer to the base URL of the database.
|
|
|
|
For more information on _Route_ instances see the
|
|
[_Route API_ below](../Route.md).
|
|
|
|
**Examples**
|
|
|
|
```js
|
|
const db = new Database();
|
|
const myFoxxService = db.route('my-foxx-service');
|
|
const response = await myFoxxService.post('users', {
|
|
username: 'admin',
|
|
password: 'hunter2'
|
|
});
|
|
// response.body is the result of
|
|
// POST /_db/_system/my-foxx-service/users
|
|
// with JSON request body '{"username": "admin", "password": "hunter2"}'
|
|
```
|