GET and Open API Project Essay Assignment

GET and Open API Project Essay Assignment

Submit a proposal for your microservice using both human english and the OpenAPI specification.

Assignment Part 1:

Submit a proposal/design in the form of a subdirectory under services with corresponding markdown and yaml files

Create a README.md and list the project name, description.

Answer the following within the README.md:

Where will it be hosted (esus, personal website, google, AWS, Azure, etc…)?

What will the endpoint look like? Include a few example requests and responses.

What language/framework/tech stack you will use?

Show how it can be tested (cURL requests, javascript client i.e. react app, etc…)

Create a corresponding api.yaml specification defining at least 1 GET endpoint exposing an input parameter that will affect the response output. The api.yaml file must be based on the open API v3.0 standard and compile properly..

The point about:

README.md proposal is created as specified

api.yaml OpenAPI v3.0 specification describing the endpoint(s)

Assignment Part 2

Based on your proposal from Part 1 (adjust if necessary) – build and deploy the underlying service fulfilling the API

The service must contain at minimum 1 GET endpoint

The endpoint(s) must return valid JSON

Must include a README.md that details how to run locally and deploy, and the names of the students in the group

Submit as a package of files under the services directory and in the description of the Pull Request specify the URL this service is deployed at for testing / validation

the point bout :

Pull Request with source code for the service AND deployed URL in description

README.md – containing student names, local development instructions, and example code to invoke API

Working URL for 1 GET request as specified in README

Valid JSON response that matches the contract specified in the Open API yaml file

PLACE THE ORDER WITH US TODAY AND GET A PERFECT SCORE!!!