Skip to content

karldreher/example-api-quick-hello

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 

Repository files navigation

example-api-quick-hello

How quick can we say hello?

This repo has several examples of a dead-simple API implementation.

The reason for this is to demonstrate a simple concept in multiple languages, as well as to have a basis for understanding client bottlenecks. By having a baseline of a server that should respond very quickly, we can reason over how to make it better (on both the client and server side).

And, this will probably be fun.

API Specification

When a request is made to GET /api/hello, a HTTP 200 response is delivered with a JSON-parseable response containing the following:

{
    "data":"world"
}

Repo Tooling

Because multiple languages will be represented here, .gitignore will be in multiple folders. In the short term, npx gitignore <lang> will be used to quickly create gitignores for each folder.

Servers

Within the servers/ directory, examples of a server which meets the API spec above will be given.
A dockerfile will be maintained in each folder, so that the example can be built and launched quickly.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published