Categorygithub.com/compico/apilearn
modulepackage
0.0.0-20240927093614-62be49493948
Repository: https://github.com/compico/apilearn.git
Documentation: pkg.go.dev

# README

Apilearn

Небольшой проект с inmemory хранилишем для изучения взаимодействия frontend'а и backend Эндпоинты совсем не по REST стандарту, если кто-то может поменять - киньте PR

Интерфейсы

МетодИнтефейсыОписание
GET/api/v1/getbookslistПолучение список всех книг
GET/api/v1/getbook/{book_id}Получение книги по id
DELETE/api/v1/deletebook/{book_id}Удалить книгу из списка
POST/api/v1/updatebook/{book_id}Обновить информацию книги
PUT/api/v1/addbookДобавить книгу
GET/api/v1/getlengthlistПолучить количество книг
PUT/api/v1/addtestbooksДобавить тестовые книги

Примеры запросов-ответов


Запрос:

GET /api/v1/getbookslist

Ответ:

Status code 200

[
            {
            "id": 0,               //number
            "name":"bookname",     //string
            "author":"bookauthor", //string
            "pages": 15            //number
            },
            {
            "id": 2,
            "name":"anotherbookname",
            "author":"anotherbookauthor",
            "pages": 15
            },
]

Запрос:

GET /api/v1/getbook/0

Ответ:

Status code 200

{
    "id": 0,
    "name":"bookname",
    "author":"bookauthor",
    "pages": 15
}

Запрос:

DELETE /api/v1/deletebook/0

Ответ:

Status code 200


Запрос:

POST /api/v1/updatebook/{book_id}

{
    "name":"bookname",
    "author":"bookauthor",
    "pages": 25
}

Не обязательно заполнять все поля.

Ответ:

Status code 200


Запрос:

PUT /api/v1/addbook

{
    "name":"bookname",
    "author":"bookauthor",
    "pages": 25
}

Ответ:

Status code 202


Запрос:

GET /api/v1/getlengthlist

Ответ:

{
     "_length":10
}

Status code 200


Запрос:

PUT /api/v1/addtestbooks

Ответ:

Status code 200

# Packages

No description provided by the author
No description provided by the author