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

Question

[Владимир Шикльгрубер]

Привет. По ходу написания api я его и описываю. Вот пример api регистрации
dock-genarais.esy.es/Users.getNewLogin Правильно делаю? За пример взяты доки вк. Зараниее спасибо

Answer 1

[Алексей Уколов]

PASSWORD, но SLOVO.

Comments

[Владимир Шикльгрубер]

а как обозначить секретное слово?

[Алексей Уколов]

Владимир Шикльгрубер: SECRET, WORD на худой конец.

[Алексей Юхновец]

Владимир Шикльгрубер: На английском, SECRET || SECRET_WORD

[Владимир Шикльгрубер]

Алексей Уколов: а так более мение?

Answer 2

[Эдуард Тибет]

Есть два способа описания API: "от структурных единиц" и от задач.
1. "от структурных единиц": функция A делает Б.
2. от задач: чтобы сделать Д надо использовать E, Ж, З

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

Пример "от задач": api.ecwid.com