Skip to content

Latest commit

 

History

History
169 lines (147 loc) · 13.6 KB

API-doc-sites-list.md

File metadata and controls

169 lines (147 loc) · 13.6 KB
Raw

Обзор сайтов с API документацией

Вместо того, чтобы подходить к теме публикации в перспективе, начнем с некоторых конкретных примеров и перейдем к формулированию общих принципов. Ниже приведено более 100 открыто доступных API-интерфейсов REST, которые можно просмотреть для изучения шаблонов и примеров. Много других API можно найти, просматривая programmableweb.com.

100+ сайтов с API документацией

Programmableweb.com: каталог сайтов документации API в открытой сети

Практическое занятие: Поиск общих паттернов на сайтах API документации

100+ сайтов с API документацией

Просмотрим некоторые из этих сайтов документации, чтобы получить представление о разнообразии, а также попытаемся определить общие закономерности. В этот список включены не только впечатляющие документы, но и документы, которые выглядят так, как будто они были созданы стажером отдела, изучающим HTML. Разнообразие в списке демонстрирует множество опций для публикации инструментов и подходов, а также терминологию. Кажется, что почти каждый делает свои документы API по-своему, со своим брендингом, организацией и стилем.

  1. Shopgate API docs
  2. Google Places API docs
  3. Twitter API docs
  4. Flickr API docs
  5. Facebook’s Graph API docs
  6. Youtube API docs
  7. eBay API docs
  8. Amazon EC2 API docs
  9. Twilio API docs
  10. Last.fm API docs
  11. Bing Maps docs
  12. gpodder.net Web Service docs
  13. Google Cloud API docs
  14. Foursquare Places API docs
  15. Walmart API docs
  16. Dropbox API docs
  17. Splunk API docs
  18. Revit API docs
  19. Docusign API docs
  20. Geonames docs
  21. Adsense API docs
  22. Box API docs
  23. Amazon API docs
  24. Linkedin REST API docs
  25. Instagram API docs
  26. Zomato API docs
  27. Yahoo Social API docs
  28. Google Analytics Management API docs
  29. Yelp API docs
  30. Lyft API docs
  31. Facebook API docs
  32. Eventful API docs
  33. Concur API docs
  34. Paypal API docs
  35. Bitly API docs
  36. Callfire API docs
  37. Reddit API docs
  38. Netvibes API docs
  39. Rhapsody API docs
  40. Donors Choose docs
  41. Sendgrid API docs
  42. Photobucket API docs
  43. Mailchimp docs
  44. Basecamp API docs
  45. Smugmug API docs
  46. NYTimes API docs
  47. USPS API docs
  48. NWS API docs
  49. Evernote API docs
  50. Stripe API docs
  51. Parse API docs
  52. Opensecrets API docs
  53. CNN API docs
  54. CTA Train Tracker API
  55. Amazon API docs
  56. Revit API docs
  57. Citygrid API docs
  58. Mapbox API docs
  59. Groupon API docs
  60. AddThis Data API docs
  61. Yahoo Weather API docs
  62. Glassdoor Jobs API docs
  63. Crunchbase API docs
  64. Zendesk API docs
  65. Validic API docs
  66. Ninja Blocks API docs
  67. Pushover API docs
  68. https://pushover.net/api
  69. Pingdom API docs
  70. Daily Mile API docs
  71. Jive docs
  72. IBM Watson docs
  73. HipChat API docs
  74. Stores API docs
  75. Alchemy API docs
  76. Indivo API 2.0 docs
  77. Socrata API docs
  78. Github API docs
  79. Mailgun API docs
  80. RiotGames API docs
  81. Basecamp API docs
  82. ESPN API docs
  83. Snap API docs
  84. SwiftType API docs
  85. Snipcart API docs
  86. VHX API docs
  87. Polldaddy API docs
  88. Gumroad API docs
  89. Formstack API docs
  90. Livefyre API docs
  91. Salesforce Chatter RESt API docs
  92. The Movie Database API docs
  93. Free Music Archive API docs
  94. Context.io docs
  95. CouchDB docs
  96. Smart Home API (Amazon Alexa) docs
  97. Coinbase docs
  98. Shopify API docs
  99. Authorize.net docs
  100. Trip Advisor docs
  101. Pinterest docs
  102. Uber docs
  103. Spotify API
  104. Trello API
  105. Yext API
  106. Threat Stack API docs
  107. Strava API
  108. Plaid API
  109. Paymill API
  110. Rundown API
  111. Zype API

Последний раз эти ссылки проверялись в марте 2019 года. Учитывая, как все быстро меняется, некоторые ссылки могут быть устаревшими. Однако, если просто набрать {product} + api docs в поиске Google, скорее всего, найдется сайт документации для разработчиков компании. Чаще всего документы по API находятся у разработчика. {Company} .com.

Programmableweb.com: каталог сайтов документации API в открытой сети

Каталог сайтов документации API можно найти на Programmableweb.com docs. Там можно просматривать тысячи документов по веб-API в различных категориях.

catalog

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

👨‍💻 Практическое занятие: Поиск общих паттернов на сайтах API документации

В этом упражнении попробуем определить общие шаблоны на сайтах документации API.

  1. Открываем наш список сайтов
  2. Выбираем 4-5 разных API (любые из списка)
  3. Ищем шаблоны или общие черты этих сайтов API. Например, можно поискать любой из следующих шаблонов:
  • структура;
  • брендинг (между документами и маркетинговым сайтом);
  • объемные примеры кода и подсветка синтаксиса;
  • длинные страницы;
  • интерактивность API (например, как API Explorer);
  • инструментарий docs-as-code;
  1. Обратим внимание на отклонения от шаблонов, такие как следующие:
  • PDF;
  • перевод;
  • видео инструкции;
  • функции комментирования;
  • множественные выводы для роли
  1. Сделаем заметки по своим наблюдениям на будущее.

В следующем разделе мы рассмотрим Шаблоны проектирования сайтов API документации Из сделанных заметок посмотрим, соответствуют ли выделенные шаблоны тем, которые мы наблюдали на выбранных сайтах API.

🔙

Go next ➡