peclevens / event-apis-specs

Event management APIs specification and documentation.

Event APIs Specifications

This project is part of a set in an effort to create a production's grade application using leading technologies following best practices. The application is intented to have very simple use cases, yet build around sophisticated Software architecture and design principles to assure good Software quality characteristics like maintainability, correctness, reusability, reliability, portability, and efficiency.

The sample application will allow its users to retrieve, create, edit and delete technology conferences/events and their sessions. This idea was taken from Joe Eames and Jim Cooper online course Angular Fundamentals at Pluralsight.

Requirements

To run the APIs documentations portal, the following tools are required:

1. Docker installed, configured and running.

Getting Started

To run the APIs documentations portal, please run the following command to build a docker image, create and run a docker container name docs.

1. with bare Docker commands

docker build -t event-apis-docs:1.0.0 . && \
	docker run --name event-apis-docs -p 8082:8080 -d event-apis-docs:1.0.0

2. with GNU Make

Before you can manage the project with the make tool, please make sure it is installed in your system.

# Build
make build

# Release 
make release

# Clean
make clean

# Optionally you can customize the build by providing environment variables as follow.
make build -e CONTAINER_NAME=docs VERSION=1.0
make release -e CONTAINER_NAME=docs -e PORT=8080 VERSION=1.0
make clean -e CONTAINER_NAME=docs VERSION=1.0

After successful execution of the command, please enter the following address in your browser to see the APIs documentations portal.

http://localhost:8082

API List Documentations

Click any link to visit its API specification.

• Event API

Notes

• The following JSON schema keywords oneOf, anyOf and allOf are valid in OpenAPI 3.0, but they are not yet supported in Swagger Editor nor in Postman which will prevent some schemas from being validated or loaded successfully.

Author Contact Information

• Linkedin
• Facebook
• Twitter

References

• Convert JSON Schema to Java POJO This converter is available online here to generate a download Java POJO. It also provides a command line interface (CLI), maven and gradle plugin to generate all POJOs from all schemas in a specific directory.
• Convert JSON Schema to Java POJO This converter offers option to convert schemas to other languages like Java, Go, C++, C#, JavaScript, TypeScrypt, Swift, Objective C, Kotlin and others.
• JSON to Json Schema generator
• JSON Formatter
• JSON Generator Tool This site helps creating payload base on prebuilt custom functions.
• JSON Handy Converter This site allows converting JSON to a handfull list of other format like SQL, YAML, CSV, XML, HTML Table and vice versa.
• Convert JSON to CSV
• APIMATIC Developer platform which allows to generate SDK, Code samples, test cases, docs in a wide range of languages like Java, Android, iOS, Angular, GO, Node and others. Tranform API Specifications from OpenAPI, Swagger, RAML and other format to Postman collections and others.
• JSON Schema Validator
• Box API Docs
• OpenAPI 3.0.2 Specs
• HTTP Status Codes
• HTTP Headers docs
• Reusable OpenAPI schemas and others
• OpenAPI Tools
• Swagger OpenAPI Online Editor