dan-mcm / inspiration-api Goto Github PK

Generate OpenAPI Specification for API

Provide a PUT /quotes endpoint to allow users to submit their own quotes & authors to the service. Have it write to a local file for initial manual vetting.

Allow for the DELETE /quotes of suggested additions

If additional entires are added to the DB via the POST endpoint the GET endpoint is limited to only accessing the first 10 items. This should be replaced with a dynamic number that is based on the count of entires from the DB at the time of being called.

Provide functionality to read quotes directly from a JSON file instead of array of string values.

Implement tracking of different endpoint usage.

Successful Criteria:

• Dockerfile setup that intiates a basic postgres image
• Auto generation of table containing three columns: id, quote, author

Graph usage of various endpoints at /analytics

Setup POST endpoint /inspiration to allow users to submit a URL that contains an authors name, and returns a list of quotes from that author

Auto-Generate SDK using Swagger-Codegen service based on Swagger file.