Giter VIP home page Giter VIP logo

jeket / learnapidoc-ru Goto Github PK

View Code? Open in Web Editor NEW

This project forked from docops-hq/learnapidoc-ru

0.0 0.0 0.0 66.06 MB

Курс по документированию API. Вольный перевод курса https://idratherbewriting.com/learnapidoc/, составленного Томом Джонсоном, техническим писателем Amazon.

License: Apache License 2.0

learnapidoc-ru's Introduction

GitHub repo size in bytes GitHub last commit GitHub watchers GitHub stars

Курс по документированию REST API

Вольный перевод курса Documenting APIs: A guide for technical writers, составленного Томом Джонсоном, техническим писателем Amazon.

Цель перевода курса:

  • пройти курс, научиться документировать API, повысить свои soft skills техписателя;
  • освежить знания английского языка;

Данный репозиторий используется для хранения исходников перевода.

Сайт русскоязычной версии курса: Starkovden.github.io

Коротко о курсе

Курс по написанию документации REST API предполагает практический подход к документированию REST API вместо лекций об абстрактных понятиях. На этом курсе займемся изучением документации API на примерах использования API сервисов прогноза погоды.

Разбирая API, мы узнаем о конечных точках, параметрах, типах данных, аутентификации, curl, JSON, командной строке, консоли разработчика Chrome, JavaScript и других деталях, связанных с REST API.

Идея курса в следующем: посмотреть на реальные сценарии использования API, вместо изучения концептов API независимо от контекста, что сделает этот курс намного эффективнее.

Во время прохождения курса мы изучим стандарты, инструменты и спецификации REST API. Узнаем о необходимых разделах в документации API, проанализируем примеры документации REST API различных компаний, узнаем, как присоединиться к проекту c открытым исходным кодом, чтобы получить опыт, и многое другое.

Начать обучение 👨‍💻

Модули курса

  1. Введение в REST API

  2. Использование API в роли разработчика

  3. Документирование конечных точек

  4. Спецификация OpenAPI и Swagger

  5. Тестирование документации

  6. Концептуальные разделы

  7. Публикация документации

  8. Работа технического писателя

  9. Нативные библиотеки API

  10. Глоссарий API и источники

  11. Документирование кода

Go next ➡

learnapidoc-ru's People

Contributors

ka1bi4 avatar lechatbotte avatar nickvolynkin avatar romanthekat avatar serembon avatar starkovden avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.