Skip to content

josephgardner/rest-design

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 

Repository files navigation

This repo attempts to model the sample webapibook/issuetracker REST API.

The issuetracker was chosen because it provides a simple example of a Web API that conforms to the contraints of REST.

Goals

  1. Accurately model resources and relations as a state machine diagram.
  2. Create an API specification as the source of truth.
  3. Generate documentation from the API specification.
  4. Generate a mock server from the API specification.
  5. Generate the state machine diagram in step 1. from the API specification.
  6. Create consumer-driven contracts that are validated by the API specification.
  7. Generate a mock server from the consumer-driven contracts.

diagram

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published