Download as PDF, PPTX
![Библиотека Climax.Web.Http
[VersionedRoute("v2/values", Version = 2)]
config.ConfigureVersioning(
versioningHeaderName: "version", vesioningMediaTypes: null);
config.ConfigureVersioning(
versioningHeaderName: null,
vesioningMediaTypes: new [] { "application/vnd.model"});
15](https://image.slidesharecdn.com/restfulapi-160912115722/85/RESTFul-API-NET-15-320.jpg)
![Katana – реализация OWIN от Microsoft
21
[assembly: OwinStartup(typeof (Startup))]
namespace RestApiDemo
{
public class Startup
{
public void Configuration(IAppBuilder app)
{
var config = new HttpConfiguration();
config.MapHttpAttributeRoutes();
app.UseWebApi(config);
}
}
}](https://image.slidesharecdn.com/restfulapi-160912115722/85/RESTFul-API-NET-21-320.jpg)
![Простейший контроллер
23
[RoutePrefix("positions")]
public class PositionsController : ApiController
{
[HttpGet]
[Route]
public IEnumerable<PositionModel> GetAll()
{
return testData;
}
PositionModel[] testData = /*initialization here*/
}](https://image.slidesharecdn.com/restfulapi-160912115722/85/RESTFul-API-NET-23-320.jpg)
![Зависимый контроллер
25
[RoutePrefix(“positions/{positionId}/interviews")]
public class InterviewsForPositionController : InterviewsController
{
[HttpGet]
[Route]
[EnableQuery]
public IQueryable<InterviewModel> GetAll(int vacancyId)
{
return GetAllInterviews().Where(x => x.VacancyId == vacancyId);
}
}](https://image.slidesharecdn.com/restfulapi-160912115722/85/RESTFul-API-NET-25-320.jpg)
![28
[RoutePrefix("positions")]
public class PositionsController : ODataController
{
[HttpGet]
[Route]
[EnableQuery]
public IQueryable<PositionModel> Get()
{
return testData.AsQueryable();
}
PositionModel[] testData = /*initialization here*/
}
OData](https://image.slidesharecdn.com/restfulapi-160912115722/85/RESTFul-API-NET-28-320.jpg)
Uploaded byYulia Tsisyk
Юлия Цисык «RESTFul API в вашем.NET приложении: как, зачем и почему?»
Документ описывает основы и лучшие практики проектирования RESTful API в приложениях на платформе .NET. Обсуждаются принципы REST, различные виды API, важность хорошего API, а также принципы версии и проектирования интерфейсов. Упоминаются технологии, такие как WCF и OWIN, и демонстрируются примеры реализации API с использованием OData.
More Related Content
![Тестирование API дизайна [NoBugs WTF PRO уровень]](https://cdn.slidesharecdn.com/ss_thumbnails/api-240916193321-d06a7fff-thumbnail.jpg?width=640&height=640&fit=bounds)
Юлия Цисык «RESTFul API в вашем.NET приложении: как, зачем и почему?»
- 1. RESTful API ввашем .NET приложении: Как, зачем и почему? Юлия Цисык, CUSTIS MSK DOT NET MeetUp #2
- 2. Зачем... • Нужно думатьоб API? Почему… • Именно REST и чем он хорош? Как… • Делать АПИ хорошо? • Версионировать? • “Открыть” данные с помощью OData? • Проектировать доменную модель? 2
- 3. Что такое API? AplicationProgram Interface • Набор правил и механизмов 3
- 4. Почему хороший APIэто важно? • Легко использовать и поддерживать • API - это UI для разработчиков • Увеличивает популярность сервиса 4
- 5. Какие виды APIбывают? • Web service APIs • XML-RPC and JSON-RPC • SOAP • REST • WebSockets APIs • Library-based APIs • Java Script • Class-based APIs • C# API, Java • OS function and routines • Access to file system • Access to user interface • Object remoting APIs • CORBA • .Net remoting • Hardware APIs • Video acceleration (OpenCL…) • Hard disk drives • PCI bus • … 6
- 6. Какие виды APIнас интересуют? Web service APIs XML-RPC and JSON-RPC SOAP – Simple Object Access Protocol REST 7
- 7. Какие виды APIнас интересуют? Web service APIs XML-RPC and JSON-RPC SOAP – Simple Object Access Protocol REST 7
- 8. Что такое REST? RepresentativeState Transfer НЕ протокол. НЕ стандарт. Это архитектурный стиль 8
- 9. Принципы REST? • Клиент-сервернаяархитектура • Любые данные являются ресурсом • Любой ресурс имеет ID • Ресурсы связаны между собой • Используются стандартные методы HTTP • Сервер не хранит состояние 9
- 10. Чем REST хорош? •Онпростой! •Переиспользует существующие стандарты •REST базируется на HTTP => доступны все плюшки •Кеширование •Масштабирование •Минимум накладных расходов •Стандартные коды ошибок •Очень хорошая распространённость (даже IoT) 10
- 11. Best-practices (независимые от технологий) •SSL везде • Методы POST, PUT должны возвращать данные • Фильтрация, сортировка и постраничный вывод • Поддержка MediaType • Pretty print & gzip • Стандартное кеширование ETag & Last-Modified • Стандартные коды ошибок • Документация и версионирование 11
- 12. Версионирование • Если выоднажды опубликовали контракт, то вы обязаны его соблюдать • Breaking changes можно делать только при изменении мажорной версии 12
- 13. Semantic Versioning 13 МАЖОРНАЯ МИНОРНАЯПАТЧ дополнительная
- 14. Подходы к версионированию 14 TypeSample Complexity URL {host}/api/v2/… Minimum Custom Header api-version:2 Average Custom Accept Header Accept:application/vnd.trainmodel.v2+json Maximum
- 15. Библиотека Climax.Web.Http [VersionedRoute("v2/values", Version= 2)] config.ConfigureVersioning( versioningHeaderName: "version", vesioningMediaTypes: null); config.ConfigureVersioning( versioningHeaderName: null, vesioningMediaTypes: new [] { "application/vnd.model"}); 15
- 16. Что такое RESTfulAPI? Это такой сервис, который удовлетворяет принципам REST 16
- 17. Выбираем технологию WCF Services –webHttpBinding only – Поддерживаются только HTTP GET & POST + Разные форматы XML, JSON, ATOM Web Api + Очень простой + Open source + Все возможности HTTP + Все возможности MVC + Легкий + Тоже поддерживает кучу форматов 17
- 18. Выбираем хостинг дляWebApi • ASP.NET MVC • OWIN •IIS •Self-hosted • Azure 18
- 19. OWIN Open Web Interfacefor .Net 19
- 20. Идея OWIN • Этоспецификация (не библиотека и не платформа) • Устраняет сильную связанность веб-приложения с реализацией сервера 20
- 21. Katana – реализацияOWIN от Microsoft 21 [assembly: OwinStartup(typeof (Startup))] namespace RestApiDemo { public class Startup { public void Configuration(IAppBuilder app) { var config = new HttpConfiguration(); config.MapHttpAttributeRoutes(); app.UseWebApi(config); } } }
- 22. Проектируем интерфейс • Всересурсы в REST существительные (множественное число) • Корневые сущности API • GET /positions - Все вакансии • GET /positions/1 - Информация по вакансии с ID = 1 • GET /competitors - Все соискатели • Зависимые сущности • GET /positions/7/interviews – собеседования, назначенные на вакансию с id = 7 22
- 23. Простейший контроллер 23 [RoutePrefix("positions")] public classPositionsController : ApiController { [HttpGet] [Route] public IEnumerable<PositionModel> GetAll() { return testData; } PositionModel[] testData = /*initialization here*/ }
- 24.
- 25. Зависимый контроллер 25 [RoutePrefix(“positions/{positionId}/interviews")] public classInterviewsForPositionController : InterviewsController { [HttpGet] [Route] [EnableQuery] public IQueryable<InterviewModel> GetAll(int vacancyId) { return GetAllInterviews().Where(x => x.VacancyId == vacancyId); } }
- 26. Базовый CRUD • POST– создать новую сущность • POST /positions – JSON описание сущности целиком. Действие добавляет новую сущность в коллекцию • Возвращает созданную сущность • PUT – изменить сущность • PUT /positions/12 – Изменить сущность с ID = 12. • Возвращает измененную сущность • DELETE • DELETE /positions/12 – Удалить сущность с ID = 12. 26
- 27.
- 28. 28 [RoutePrefix("positions")] public class PositionsController: ODataController { [HttpGet] [Route] [EnableQuery] public IQueryable<PositionModel> Get() { return testData.AsQueryable(); } PositionModel[] testData = /*initialization here*/ } OData
- 29.
- 30.
- 31. Параметры запросов 31 Query OptionSample $filter Positions?$filter=Name eq ‘Программист' Positions?$filter=contains(Name, ‘инженер') $select Positions?$select=Name, Id $orderby Positions?$orderby=Name desc $top Competitors?$top=10 $skip Interviews?$skip=15&$top=15
- 32. EnableQuery Аттрибут • AllowedArithmeticOperators •AllowedFunctions • AllowedLogicalOperators • AllowedOrderByProperties • AllowedQueryOptions • EnableConstantParameterization • EnsureStableOrdering • HandleNullPropagation • MaxAnyAllExpressionDepth • MaxExpansionDepth • MaxNodeCount • MaxOrderByNodeCount • MaxSkip • MaxTop • PageSize 32
- 33.
- 34.
- 35. Клиент ORM A server librarybuilt upon ODataLib and WebApi Open Data Protocol - .NET/Silverlight/WP8.1 Libraries and Frameworks UI Odata .NET OData Web API 35
- 36.
- 37.
- 38.
- 39.
- 40.
- 41. DataContext.MdmDeliveryTypes.Where(x => x.IsShippingInRm).OrderBy(x=> x.Name) DataContext.TradingNetworkSettings.Where(o => o.Id == listDto.Key)) .Expand(o => o.TradingNetwork) .Expand(o => o.Creator) .Expand(o => o.Modifier); DataContext.PlannedScheduleItems .Where(x => (x.ReturnPlanItem.ReturnPlan.Id == filterData.ReturnPlanId) && (filterData.RegionId == null || x.ReturnPlanItemNormalizationKey.SourceShop.Region.Id == filterData.RegionId) && (filterData.SourceShopId == null || x.ReturnPlanItemNormalizationKey.SourceShop.Id == filterData.SourceShopId) && (filterData.RecipientWarehouseId == null || x.ReturnPlanItemNormalizationKey.RecieverStorage.Id == filterData.RecipientWarehouseId) && (filterData.NextWarehouseId == null || x.NextWarehouse.Id == filterData.NextWarehouseId) && (filterData.DeliveryTypeId == null || x.DeliveryType.Id == filterData.DeliveryTypeId) && (filterData.ShopClusterId == null || x.ShopCluster.Id == filterData.ShopClusterId) && (filterData.DateFrom == null || x.ReturnDate >= filterData.DateFrom.Value) && (filterData.DateTo == null || x.ReturnDate < filterData.DateTo.Value)) 41 Клиент
- 42. GET /Service/ReturnPlanItemDtos?$filter= (BeginDate ltReturnPlan/BeginDate or EndDate gt ReturnPlan/EndDate) and TradingNetwork/Id eq 19 and ReturnPlanItemNormalizationKey/SourceShop/Code eq 301 and Product/Subcategory/Id eq 66 and BeginDate ge 2015-11-02T00:00:00+03:00 and EndDate lt 2015-11-28T00:00:00+03:00 and EditStatus eq ReturnPlanItemEditStatus'Rms' and (Status eq PlanItemStatus'New' or PlanItemStatus'IncludedInSchedule') 42 Клиент
- 43. <telerik:RadMenu RenderMode="Lightweight" runat="server"ID="RadMenu1"> <WebServiceSettings Path="http://services.odata.org/OData/OData.svc"> <ODataSettings ResponseType="JSONP"> <Entities> <telerik:ODataEntityType Name="Category" DataValueField="ID" DataTextField="Name" /> </Entities> <EntityContainer> <telerik:ODataEntitySet EntityType="Category" Name="Categories" /> </EntityContainer> </ODataSettings> </WebServiceSettings> </telerik:RadMenu> 43 Клиент Telerik ASP.NET
- 44.
- 45. Проектируем API REST ≠ CRUDvia HTTP 45
- 46. Понятия DDD •Bounded Context •Aggregates •DomainEntities •Values Objects 46
- 47. Доменная модель 47 Городская транспортнаясеть Маршрут Остановочный пункт Водитель Автобус
- 48. Доменная модель 48 Городская транспортнаясеть МаршрутОстановка Остановочный пункт ВодительНазначение Автобус
- 49. Доменная модель 49 Городская транспортнаясеть МаршрутОстановка Остановочный пункт ВодительНазначение Автобус Автобусный парк Aggregate Root Bounded Context Городской маршрут
- 50. Зачем... …нужно думать обAPI? Чтобы увеличить популярность сервиса Почему… …именно REST и чем он хорош? Это современно и удобно Как? Проектируем по DDD Основываясь на REST Реализуем с OData Хостим с помощью OWIN 50
- 51.
- 52.