Exon Design API

В данном репозитории храниться спецификация API в формате OpenAPI

Регламенты работы с репозиторием

1. Общие правила для работы с репозиторием

Полезные ссылки

1. Stoplight Studio - IDE для проектирования API
2. Spectral - линтен для проверки качества написанных спецификаций
3. Prism CLI - Mock-сервер
4. OpenAPI Generator - code-generator из спецификаций OpenAPI
5. openapi-generator-cli
6. Список генераторов
7. Генератор для typescript-axios
8. Документация Stoplight
9. ModHeader - расширение для Google Chrome для отправки кастомных заголовков
10. Конфиги генератора для Typescript
11. Styleguide по работе с репозиторием

Необходимые технологии для запуска

1. Java 1.8
2. NodeJS

NPM скрипты

Скрипт	Описание
npm run lint	Запуск линтера для проверки качества спецификации
npm run mock	Запуск mock-сервера
npm run postman	Генерация postman-коллекций из спецификаций

Установка Java

• для работы OpenApi Generator необходимо установить java
• добавить в системную переменную PATH следующий путь:

<PATH_TO_JAVA>\jdk-11\bin