Skip to content
/ API Public

Contains the documentation of the upcoming (currently work in progress) EVNotify server API

Notifications You must be signed in to change notification settings

EVNotify/API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API Documentation

This repository is able to generaete the documentation for the API of the EVNotify server.

You can view the api documentation at any time from https://api.evnotify.de.

Notice:

It contains the documentation for the upcoming (not released and still work in progress) API for v3.

Prerequisites

If you want to build and generate the documentation yourself, you need the following things and structure:

  • Node.JS (v.12.16.2. tested)
  • the EVNotify services you want to build the generation for
    • They need to placed in the same root directory as this repository

Installation

npm i

Usage

npm run generate-docs

About

Contains the documentation of the upcoming (currently work in progress) EVNotify server API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published