Skip to content
This repository has been archived by the owner on Nov 30, 2020. It is now read-only.

An example API which represents a reference implementation of best practices in The Brønnøysund Register Centre

Notifications You must be signed in to change notification settings

Informasjonsforvaltning/example-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

82 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Example API

An attempt at an reference API-implementation that comply to the following set of requirements:

  • user requirements represented as usecases
  • a set of quality requirements

The requirements are translated into features (gherkin) in the feature folder.

The features are mapped into an OpenAPI-specification.

Finally, most of the tests are generated from the openAPI-specifcation, while others will be handcoded based on operational features from quality-requirements. Tests are found in the app/test-folder.

The app folder contains an example implementation of an API that should pass all of the tests.

The following diagram illustrates this loosely:

Alt text

About

An example API which represents a reference implementation of best practices in The Brønnøysund Register Centre

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published