Задать вопрос
aaadddminnn
@aaadddminnn
php it ubuntu debian
php

Правильно ли я описываю API?

Привет. По ходу написания api я его и описываю. Вот пример api регистрации
dock-genarais.esy.es/Users.getNewLogin Правильно делаю? За пример взяты доки вк. Зараниее спасибо
  • Вопрос задан
  • 405 просмотров
Комментировать
Подписаться 2 Оценить Комментировать
Решения вопроса 1
alexey-m-ukolov
@alexey-m-ukolov Куратор тега PHP
PASSWORD, но SLOVO.
Ответ написан
4 комментария
4 комментария
Пригласить эксперта
Ответы на вопрос 1
eduardtibet
@eduardtibet
Technical Writer / Documentation Engineer
Есть два способа описания API: "от структурных единиц" и от задач.
1. "от структурных единиц": функция A делает Б.
2. от задач: чтобы сделать Д надо использовать E, Ж, З

Поэтому алгоритм такой:
- определите, какой способ вам подходит;
- создайте скелетную структуру;
- наполните несколько единиц контентом (не забудьте про примеры - у вас в приведенном фрагменте их нет);
- не забудьте про ограничения использования.

Пример "от задач": api.ecwid.com
Ответ написан
Комментировать
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Похожие вопросы
Вакансии с Хабр Карьеры
Backend-разработчик PHP
Wanted. • Москва
До 160 000 ₽
PHP-разработчик
Decart IT-production
от 260 000 до 340 000 ₽
PHP-разработчик
Wanted.
До 200 000 ₽
Ещё вакансии
Заказы с Хабр Фриланса
Восстановить доступ к сайту на WordPress (вылечить trojan.inject)
25 нояб. 2024, в 21:02
30000 руб./за проект
Разобраться со скриптом на питоне
25 нояб. 2024, в 20:38
500 руб./за проект
Запустить сервер на питон
25 нояб. 2024, в 20:37
1000 руб./за проект
Ещё заказы