Giter Club home page Giter Club logo

event-apis-specs's Introduction

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.

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

References

event-apis-specs's People

Stargazers

Ralph Florent avatar

Watchers

Clivens Petit avatar Jerson Pena avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.