Project

General

Profile

Actions

Надо сделать #165

closed

Создать документацию по REST API

Added by Александр Александров about 5 years ago. Updated about 5 years ago.

Status:
Закрыта
Priority:
Нормальный
Category:
Разработка
Target version:
Start date:
11/24/2019
Due date:
12/08/2019
% Done:

100%

Estimated time:
16:00 h
Spent time:
Issue closed :
12/01/2019

Description

Необходимо создать документацию по REST API используя Spring RESTDocs

Задача разбита на следующие пункты:

  1. Создать документацию по REST API для работы с графом в целом.
  2. Создать документацию по REST API для отдельной работы с вершинами графа (нодой).
  3. Создать документацию по REST API для отдельной работы с рёбрами графа.

Checklist

  • Создать документацию по REST API для работы с графом в целом
  • Создать документацию по REST API для отдельной работы с вершинами графа (нодой)
  • Создать документацию по REST API для отдельной работы с рёбрами графа

Related issues

Precedes Linkchecker (тестовое задание) - Надо сделать #164: Создание простого web frontend с использование thymleaf и bootstrapЗакрытаАлександр Александров12/09/2019

Actions
Actions #1

Updated by Александр Александров about 5 years ago

  • Status changed from Новая to В работе
Actions #2

Updated by Александр Александров about 5 years ago

  • Estimated time changed from 15:00 h to 16:00 h
Actions #3

Updated by Александр Александров about 5 years ago

  • Tags changed from spring restdocs to spring restdocs, java, spring boot
Actions #4

Updated by Александр Александров about 5 years ago

  • Description updated (diff)
Actions #5

Updated by Александр Александров about 5 years ago

  • Precedes Надо сделать #164: Создание простого web frontend с использование thymleaf и bootstrap added
Actions #6

Updated by Александр Александров about 5 years ago

Была создана полная документация по REST API программы при помощи Spring RESTDocs. Доступ к документации можно получить через главную страницу программы (кнопка Linkchecker REST API Guide v1) или на прямую перейти к статической странице (пример http://localhost:8080/docs/api-guide-v1.html)

Actions #7

Updated by Александр Александров about 5 years ago

  • Status changed from В работе to Закрыта
Actions

Also available in: Atom PDF

Go to top