Page MenuHomePhabricator

Example Node Prototype API
Closed, ResolvedPublic

Description

Context

In order for our team to have a clear understanding of what the end-to-end user journey is for an API producer, we will create an example API prototype ourselves and consume it, end to end.

User Stories & Acceptance Criteria
1. API Creation Lifecycle

As an API Platform engineer,
I want to understand the user journey of other API producers,
so that I can document and improve the process

  • Given I want to design and deploy my own prototype API (in node), I expect to view the process to create an API (in node) step by step
  • Given I have made a request to the hello-world API, I expect to receive a 200 and "Hello World" in response
2. API Consumption Lifecycle

As an API Platform engineer,
I want to understand the user journey of API consumers,
so that I can document and improve the process

  • Given I want to discover and onboard to use an API prototype, I expect to view the process step by step
  • Given I have made a request to the hello-world API, I expect to receive a 200 and "Hello World" in response
Open Questions
  • What is the most used language for API producers?
  • What is the future state hosting technology we should adopt? e.g. Toolforge, Cloudservices, Kubernetes
References

Event Timeline

sdkim renamed this task from Improve Test Coverage & Automate CI to API Platform: Path to Production.Jun 7 2021, 9:23 PM
sdkim updated the task description. (Show Details)
sdkim renamed this task from API Platform: Path to Production to "Hello World" API Prototype.Jul 28 2021, 8:58 PM
sdkim updated the task description. (Show Details)
sdkim added a subscriber: BPirkle.
sdkim renamed this task from "Hello World" API Prototype to Example Node Prototype API.Aug 13 2021, 5:05 PM

If you're basing your example API on service-template-node, this would be a good time to remove examples from service-template-node itself and just add a reference. Would help move forward something we wanted to do for a long long time T151399

Removing inactive task assignee.

VirginiaPoundstone claimed this task.
VirginiaPoundstone subscribed.

Failure to launch.