Skip to content

Instantly share code, notes, and snippets.

View nateklaiber's full-sized avatar

Nate Klaiber nateklaiber

View GitHub Profile

API

Here are the concerns:

  • Routes: How do I get to the necessary resource?
  • Configuration: What options do I want for my connection or requests
  • Connection: How do I connect to the application? Typically this will be HTTP(S).
  • Logging: We will have specific logging for the api, the requests, and applications.
  • Errors: We will have specific exceptions we raise if any issues arise.
  • Requests: These use the routes and connections to make a request to the service. The return from this is a response.
  • Response: The response from a request is typically a schema that aligns with content negotiation (Content-Type or Accept)