Какие точки я должен рассмотреть, чтобы создать API для нового веб-сайта, который я создаю?

Question

Какие моменты я должен учитывать при создании веб-сайта и планировании поддержки пользователей API?

Я вижу, что большинство известных сайтов дают разработчикам API для решения, такие как Facebook, Twitter, Google, ....

Есть ли общие точки я должен учитывать при строительстве нового веб-сайта для быть в состоянии поддерживать разработчиков API? «просто очень общие моменты, независимо от того, работает ли сайт самостоятельно»

UPDATE все ответы ниже помогли мне много.

Answer 1

Я рекомендую дополнительные PDF и presentation от Joshua Bloch «Как разработать хороший API и почему это имеет значение».

Answer 2

Я предполагаю, что вы начнете с определения функций (например, addUser, addStory, addComment, editXYZ и т. Д., В зависимости от типа сайта), которые поддерживаются веб-сайтами, и данных, которые он предоставляет (getCommentsForStory, getStories, getUser, ...) и создание API-интерфейсов веб-сервисов для этих функций с соответствующими проверками безопасности и т. д.

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

Answer 3

мыло или XML

В зависимости от используемого приложения. Если это сложно, вам может понадобиться функциональность мыла. KISS должен применяться с особенностями API. Есть разумный URL макет, который имеет смысл с точки зрения ресурсов:

www.site.com/people/london 

В качестве ресурса.

http://en.wikipedia.org/wiki/Restful

Посмотрите на почему использование PUT, POST, GET и другие важно.

Good Luck

Answer 4

Одна простая вещь, которая может спасти вам много хлопот в будущем - включают в себя "версию API", как часть вашего URL, что-то вроде ..

www.example.com/api/v1/getAnswers/ 

Если и когда вы решите пересмотреть свой API, вам не придется беспокоиться о том, что ваш URL-адрес совместим с обратным (с нарушением существующих приложений), ваши пользователи только начинают использовать /api/v2/, и вы в конечном итоге обесцениваете прежнюю версию.

Среди других, del.icio.us и github как это сделать

Answer 5

Наиболее веской причиной, IMO, чтобы обеспечить API является то, что ваш сайт предоставляет информацию и/или услуги, которые люди будут мотивированы, чтобы взаимодействовать с программными средствами. Поскольку вы не можете предотвратить это (несмотря на многие надежды и мечты владельцев сайтов), лучше принять его, поскольку предоставление API означает, что люди могут получить доступ к именно той информации/услугам, которые они хотят, уменьшая нагрузку на ваши системы.

Answer 6

Построение хорошего api трудно и требует много практики.

первый api, который вы строите, должен быть api вашего сайта врага.

второй api для вашего сайт друга.

третий апи вы строите для ваших клиентов.