https://github.com/kasa-network/koa-http-client

💬 HTTP Client to communicate with the context during inter-service communications in Koa
https://github.com/kasa-network/koa-http-client

got http-client httpclient koa koa-middleware koajs

Last synced: 4 months ago
JSON representation

💬 HTTP Client to communicate with the context during inter-service communications in Koa

• Host: GitHub
• URL: https://github.com/kasa-network/koa-http-client
• Owner: kasa-network
• License: mit
• Archived: true
• Created: 2019-02-21T08:32:52.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-07-13T22:08:56.000Z (over 4 years ago)
• Last Synced: 2024-09-26T16:41:00.968Z (4 months ago)
• Topics: got, http-client, httpclient, koa, koa-middleware, koajs
• Language: JavaScript
• Homepage:
• Size: 12.7 KB
• Stars: 3
• Watchers: 18
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  
@kasa/koa-http-client





  A middleware that attachs HTTP client to communicate with the context during inter-service communications in Koa.





  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  






Communication between microservices must be efficient. With lots of microservices to complete a single request(transaction) successfully, each communication should have a context informations like the request id, content language, or something else. **Koa HTTP Client** will help inter-service communication with automatically attached context informations.

## Installation

```bash

# Using NPM

$ npm install --save @kasa/koa-http-client

# Using Yarn

$ yarn add @kasa/koa-http-client

```

### Dependencies

- [**Koa**](https://github.com/koajs/koa) 2.0+

- [**Node.js**](https://nodejs.org) 8.0.0+

## Usage

Use `koa-http-client` as a middleware for a [koa](https://github.com/koajs/koa) app.

```node

const Koa = require('koa');

const requestId = require('@kasa/koa-http-client');

const httpClient = require('@kasa/koa-http-client');

const app = new Koa();

app.use(requestId());

app.use(httpClient({

  retry: 3

}));

app.use(async ctx => {

  const userService = ctx.http.extend({

    baseUrl: 'http://user.company.com:8080/'

  });

  let user;

  try {

    const { body } = await userService.get('/users/john');

    user = body.user;

  } catch (err) {

    // Do something with error (HTTP status code 4xx or 5xx)

  }

  // Do something with user data

});

app.listen(3000);

```

## API

### Creating an middleware

You can create a new http client middleware by passing the relevant options to `httpClient`;

```node

const middleware = httpClient({

  forwardedHeaders: ['Accept-Language'],

  userAgent: 'user-service/0.1.0',

  requestIdHeader: 'X-Service-Request-Id',

  timeout: 20 * 1000,

  retry: 3,

});

```

### Middleware Configuration

These are the available config options for the middleware. All is optional. The middleware attachs HTTP client with the context for each request.

```node

{

  // HTTP headers to forward from Koa `ctx`

  forwardedHeaders: ['Accept-Language', 'Authorization'],

  // Client name to set `User-Agent` header

  userAgent: 'user-service/0.1.0',

  // HTTP header to get/set the request id

  requestIdHeader: 'X-Service-Request-Id',

  // Milliseconds to wait for the server to end the response before aborting the request

  timeout: 20 * 1000,

  // Count to retry on the request errors

  retry: 3,

}

```

## Credits

* [sindresorhus/got](https://github.com/sindresorhus/got): `koa-http-client` was developed based on `got`. `koa-http-client` utilizes `got.extend` feature well!

## Contributing

#### Bug Reports & Feature Requests

Please use the [issue tracker](https://github.com/kasa-network/koa-http-client/issues) to report any bugs or ask feature requests.

## License

Provided under the terms of the [MIT License](https://github.com/kasa-network/koa-http-client/blob/master/LICENSE).

Copyright © 2019, [Kasa](http://www.kasa.network).