Изучаем RESTful

31.10.2013

Привет! Сегодня я бы хотел вам написать об одной книжке, в которой описаны best practices по созданию своего качественного RESTful API.

Пожалуй, не буду вас томить, и сразу дам книжку на эту книгу. Вот она: Web API Design. Можно скачать бесплатно, как PDF-ку, так и версию книжки для iBooks.

В книжке описаны лучшие практики по строению API. Например, рассказывается:

• что к каждой сущности должно быть 2 URL (http://example.org/api/books и http://example.org/api/books/2323),
• что нужно использовать HTTP GET/POST/PUT/DELETE для CRUD-операций (а не добавлять эти слова в URL),
• что нужно использовать существительные во множественном числе для именования сущностей (http://example.org/api/books а не http://example.org/api/book),
• что нужно не множить вложенность URL для обеспечения более глубокой вложенности (http://example.org/api/authors/1212/books — нормальный способ получить все книги автора, http://example.org/api/authors/1212/books/сollaborators — плохой способ получить всех соавторов книги, у которой определенный автор).

Книга, конечно же, написана на английском языке. Однако тут он крайне простой (да и книжка всего 40 страниц, так что, можно попользоваться и словарём).

Категории: Программирование

Метки: программирование