Как начать писать собственный API?

Question

[LxstLight]

Хочу начать писать собственный API (наподобие, Spigot API) для плагинов Minecraft. С чего начать не знаю. В голове есть алгоритм создания (и то, скорее всего, поверхностный), но как его реализовать на практике - не знаю. Информации о чем-то подобном нигде нет, к сожалению.

Answer 1

[YepBro]

Для начала напиши документацию на апи. Какие методы будут, по каким протоколом (GET|POST|DELETE|PUT|PATCH) надо обращаться. Какие параметры передадаются. Какие данные будут в ответе, в какой формат. Можешь прям сделать примеры. Плюс еще надо какие ошибки будет возвращать твой апи.

После этого станет намного проще :)

Comments

[Сергей delphinpro]

Добавлю - для создания документации можно воспользоваться специализированными решениями. Например, Swagger.

[YepBro]

Сергей delphinpro, Да, правильная мысль. Но для начинающего можно и в обычном док-файле начать описывать схему апи. Главное начать процесс.

[Антон Шаманов]

думаю для начала стоило разобраться что такое Spigot API, судя по тому что я вижу, это скорее можно назвать sdk и соответственно ваше описание REST тут ни к месту

[YepBro]

Да! В таком случае про протоколы и Swagger можно вычеркнуть, но все остальное по прежнему верно.

[Антон Шаманов]

YepBro, на самом деле нет т.к. нужна не документация (она формируется на основе комментов и кода), а архитектура/схема

[YepBro]

Антон Шаманов, начинающего разработчика слова архитектура/схема больше напугает, чем чем-то поможет :)

[Антон Шаманов]

YepBro, перед тем чтобы браться за подвиги, убедись что ты в сказке

[VoidVolker]

Неплохая альтернатива перегруженному сваггеру/опенапи: https://jsight.io/