openapi-audit-engine

Make your API definition (Open API Standard) clean.

Based on stoplightio/spectral

UI

The UI is handled by RTabary/openapi-audit-engine-front

API

The backend API is handled by RTabary/openapi-audit-engine-back

Run application (Docker)

$ docker-compose pull
$ docker-compose -f "docker-compose.yml" up -d --build

The UI is available at http://localhost:4200
The API is available at http://localhost:3000

Use your own rules

As previously mentionned, this project is based on stoplightio/spectral which allows you to create your own custom rules.
Simply bind the folder containing your own rules to the container:

version: '2.0'
services:
  front:
    image: roms/openapi-audit-engine-front:latest
    ports:
    - "4200:4200"
  back:
    image: roms/openapi-audit-engine-back:latest
    volumes: 
    - "/path/to/local/spectral/conf:/usr/src/app/dist/assets:ro"
    ports: 
    - "3000:3000"