~romuloalves/micro-post

Package to only accept POST request for microservices built with zeit/micro
e9c5d2c8 — romuloalves 1 year, 11 days ago
v2.2.0
e2911ed6 — Rômulo Alves 1 year, 11 days ago
Merge pull request #10 from romuloalves/dependabot/npm_and_yarn/lodash.merge-4.6.2
a682e453 — dependabot[bot] 1 year, 11 days ago
Bump lodash.merge from 4.6.1 to 4.6.2

refs

master
browse  log 

clone

read-only
https://git.sr.ht/~romuloalves/micro-post
read/write
git@git.sr.ht:~romuloalves/micro-post

You can also use your local clone with git send-email.

micro-post

Package to only accept POST request for microservices built with Micro.

XO code style

About

When developing a microservice with Nodejs and zeit/micro you may want to accept only POST methods. micro-post is a simple package that allows you to achieve this with a lot of simplicity.

Just encapsulating your existing function in the micro-post default exported function will automatically validate the requests, include the Access-Control-Request-Method and status code in the response header, and response body with Method Not Allowed.

The package allows you to modify it's response code, plain text, change the response by a JSON or even execute a function to manage the request by your own. You can find how to do that in the examples section.

Installation

Install using npm:

npm install --save micro-post

Install using yarn:

yarn add micro-post

Usage

Basic

This is the basic usage. When a non-POST request is received, the response will be 405 – Method Not Allowed.

const post = require('micro-post')

module.exports = post(async (req, res) => {
  return `It's a POST request!`
})

With options

You can parameterize some different responses like other messages, JSON and even a function to manage the request by your own.

const post = require('micro-post')

const options = {
  errorCode: 404,
  response: 'My custom response',
  contentType: 'text/plain'
}

module.exports = post(options, async (req, res) => {
  return `It's a POST request!`
})

Examples

Each example has its own README explaining how to execute it.

All default options: default

Example that use the default options of the package.

Custom Message: custom-message

The response is a custom message Changing the default message is simple as breathe with content-type text/plain.

Custom JSON: custom-json

The response is a custom JSON with content-type application/json.

The package change automatically the content-type to application/json in case your response property in the options parameter is an object.

{
  error: {
    message: 'Invalid method'
  }
}

Custom HTML: custom-html

The response is a custom HTML with content-type text/html.

Custom Function: custom-function

Before the response ends, the function that receives the request and the response from HTTP is called.

Developing/Contributing

Feel free to open issues and create PRs! :)

This package is linted by XO and tested by AVA.

After install the dependencies you can execute npm test, that will test different responses. Each test creates its Micro instance to simulate a real environment.

License

MIT License

Copyright (c) 2016 Rômulo Alves

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.