Monasca REST API
Go to file
Jonathan Halterman be25155f66 Added license file 2014-05-01 16:22:11 -07:00
etc/security Added key and trust stores 2014-02-19 17:48:28 -08:00
src Removed mon-http dependencies 2014-05-01 16:19:06 -07:00
.gitignore updated pom with Debian code to produce .deb file 2014-03-07 10:56:12 -05:00
LICENSE Added license file 2014-05-01 16:22:11 -07:00
README.md Update readme to add swagger-ui link 2014-04-23 16:12:31 -07:00
pom.xml Removed mon-http dependencies 2014-05-01 16:19:06 -07:00

README.md

Overview

mon-api is a RESTful API server that is designed with a layered architecture layered architecture.

Usage

mvn package
java -jar target/mon-api.jar server config-file.yml

Design Overview

Architectural layers

Requests flow through the following architectural layers from top to bottom:

  • Resource
    • Serves as the entrypoint into the service.
    • Responsible for handling web service requests, and performing structural request validation.
  • Application
    • Responsible for providing application level implementations for specific use cases.
  • Domain
    • Contains the technology agnostic core domain model and domain service definitions.
    • Responsible for upholding invariants and defining state transitions.
  • Infrastructure
    • Contains technology specific implementations of domain services.

Docs and Test Interface

When running mon-api the API docs along with the API test interface can be accessed via:

http://localhost:8080/swagger-ui/