​Генерация API-документации из docstrings на Python

Все любят хорошую и полную документацию, особенно во время знакомства с новой библиотекой. Но написать документацию с нуля может быть и сложным, и обременительным занятием.

К счастью есть инструмент, который сам генерирует документацию из функций. Подробнее о нём в статье:

https://nuancesprog.ru/p/14983/

#api

​Свой API на Django

Полуторачасовая серия уроков, посвящённая созданию своего API (Application Programming Interface). Этот урок хорош тем, что объясняет не только логику вёрстки API, но и помогает развернуть проект на Django с нуля.

Ссылка на плейлист

#api #django

​InstaAPI — low-code конструктор API

С помощью InstaAPI вы сможете легко создавать собственные API.

Вы получите доступ к библиотеке блоков кода, которые помогут создать логические компоненты и воплотить ваши идеи в реальность. Одним из преимуществ InstaAPI является встроенная SQL-база данных.

#API

​Newsi: API для новостей

Инструмент полезен в трейдинге и позволяет автоматизировать подгрузку англоязычных мировых новостей. В дальнейшем на результаты запроса можно навесить показатели эмоциональной окраски и в зависимости от этого упростить принятие инвестиционного решения.

Документация

#API

​1secmail: анонимная почта на Python

Автор видео описывает, как обратиться к API 1secmail.com на Python. В 13-минутном ролике вы узнаете:

— как создать ящик с нужным именем;
— как читать почту в командной строке;
— как настроить регулярную перепроверку ящика.

#api

​litestar для создания собственных API

Если вам посчастливилось создавать свой API, фреймворк предоставит следующие возможности:

— высокопроизводительная проверка и анализ данных;
— внедрение зависимостей;
— интеграция ORM;
— примитивы авторизации и проч.

Ссылка на репозиторий

#API

​django-ninja для создания API

Веб-фреймворк позволяет по сути создавать приложения, которые потом встраиваются в Django-проект:

from ninja import NinjaAPI

api = NinjaAPI()


@api.get("/add")
def add(request, a: int, b: int):
return {"result": a + b}

Документация

#API

Трехстраничная шпаргалка, с помощью которой вы узнаете:

— как называются части URL в контексте запроса;
— зачем нужны те или иные заголовки запросов (например, Accept-Charset / User-Agent);
— чем отличается код 300 от 500

#api #шпаргалка

tiny-api-client для своих эндпоинтов

Короче способа создать API, пожалуй, трудно найти:

from tiny_api_client import api_client, get, post, delete

@api_client('https://example.org/api/public/v{version}')
class MyAPIClient:
 @get('/users/{user_id}')
 def find_user(self, response):
  return response

 @post('/notes')
 def create_note(self, response):
  return response

>>> client = MyClient()
>>> client.find_user(user_id='PeterParker')
{'name': 'Peter', 'surname': 'Parker', ...}

Проект на GitHub

#API

​​Книга «Паттерны проектирования API»

Сотрудник Google Джей Гивакс рассказывает о том, как в компании создают масштабируемые и гибкие сервисы. Вы узнаете, как улучшить дизайн самых распространённых API и как действовать в сложных пограничных случаях. Сопровождается иллюстрациями и примеры кода.

Профиль на Литрес

#api #книга