iamlucianojr / quotes-api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Quotes API

PHPUnit code coverage report

Installation

Use docker to install the container services.

cp .env.dist .env
docker-compose up -d

This command will install an instance of Nginx and Redis services.

Usage

You can get the postman collection using the button:

Run in Postman

There are only one endpoints in the collection:

/shout To request quotes shouted

To use you need to ask for quotes of some person:

/shout/steve-jobs?limit=2 To request two quotes from Steve Jobs

/shout/albert-einstein?limit=1 To ask for one quote from Albert Einstein

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

About


Languages

Language:PHP 98.5%Language:HTML 0.8%Language:Shell 0.4%Language:Dockerfile 0.3%