Api crash
•Download as PPTX, PDF•
0 likes•107 views
This document provides an overview of APIs, including what they are, why they are useful, common data formats like JSON and XML, RESTful API design principles, and how to consume and create APIs. It discusses API concepts like resources, HTTP verbs, caching, authentication, and error handling. It also provides examples of consuming APIs with tools like Postman and creating a simple API in Node.js.
Report
Share
Report
Share
Recommended
Api crash
This document provides an overview of APIs, including what they are, why they are useful, common data formats like JSON and XML, RESTful API design principles, and how to consume and create APIs. It discusses API concepts like resources, HTTP verbs, caching, authentication, and error handling. It also provides examples of consuming APIs with tools like Postman and creating a simple API in Node.js.
Rest api to integrate with your site
This document discusses Easyrec, an open source recommender engine that provides recommendations based on user actions like views, purchases, and ratings of products. It has an API that allows integrating recommendations into a website by passing a user ID and token. The API can take in user data and return recommendations based on what other similar users viewed, purchased, or rated highly. While Easyrec is easy to use, it has limitations in flexibility and only supports collaborative filtering recommendations.
How to build a rest api
This document outlines an agenda to introduce REST and building APIs with ASP.NET Web API. It begins with a quick demo, then discusses what REST is as an architectural style based on HTTP using resources and verbs. It covers HTTP concepts like requests, responses and status codes. Finally, it demonstrates building a REST API with ASP.NET Web API and discusses advantages of REST like using the well-defined HTTP protocol and enabling caching.
Best Practice in Web Service Design
This document provides an overview and best practices for API design. It discusses when to build an API, such as to share data between apps or give users control over their data. It covers HTTP fundamentals like requests and responses, status codes, headers, and verbs. It also discusses different service types like RPC and RESTful services. The document provides tips on design considerations for APIs like target audience, statelessness, versioning, error handling, and access control.
4th Lecture: JSP and such
- The document discusses web technologies including Java Server Pages (JSP) and servlets.
- It describes how servlets generate dynamic web page content by running Java code that outputs HTML. Servlets are mapped to URLs via a deployment descriptor file.
- JSPs are introduced as an improvement over servlets that embeds Java code directly in HTML files, allowing clear separation of design and programming tasks. The container handles request routing and servlet lifecycle management.
Technology Stack Discussion
Zaiyang Li discusses the technology stack for a project, including the front-end framework Angular and build tools like Webpack, and the back-end framework ASP.NET Core with libraries like Dapper and testing tools like Xunit and Moq. Chart.js is used for data visualization, and a bespoke event sourcing framework is in active development to run in the same process as the web server. Protocol buffers are used for serialization and provide benefits like high performance and backward compatibility.
Web Planning an Effective Integration with a 3rd party API to Scale
The document provides tips for using web services to integrate with third parties. It discusses what web services are, how to get started with them, best practices like favoring REST over SOAP, handling errors, testing integrations, and maintaining communication with third party technical resources. The overall message is that web services require careful documentation review, testing, and collaboration to build reliable integrations at scale.
Why use Go for web development?
This document discusses the suitability of Go for web development. It notes that while Go's built-in HTML template engine is basic, the Gorazor template engine provides a more powerful way to mix Go code into HTML templates. Code generation approaches also allow Go to behave more dynamically at runtime. Go's fast compilation and use of interfaces make it well-suited for dynamic web applications and large websites. The document concludes that while other languages may be more mature, Go is suitable for developing large, stable, scalable websites that need to be maintained over time.
Recommended
Api crash
This document provides an overview of APIs, including what they are, why they are useful, common data formats like JSON and XML, RESTful API design principles, and how to consume and create APIs. It discusses API concepts like resources, HTTP verbs, caching, authentication, and error handling. It also provides examples of consuming APIs with tools like Postman and creating a simple API in Node.js.
Rest api to integrate with your site
This document discusses Easyrec, an open source recommender engine that provides recommendations based on user actions like views, purchases, and ratings of products. It has an API that allows integrating recommendations into a website by passing a user ID and token. The API can take in user data and return recommendations based on what other similar users viewed, purchased, or rated highly. While Easyrec is easy to use, it has limitations in flexibility and only supports collaborative filtering recommendations.
How to build a rest api
This document outlines an agenda to introduce REST and building APIs with ASP.NET Web API. It begins with a quick demo, then discusses what REST is as an architectural style based on HTTP using resources and verbs. It covers HTTP concepts like requests, responses and status codes. Finally, it demonstrates building a REST API with ASP.NET Web API and discusses advantages of REST like using the well-defined HTTP protocol and enabling caching.
Best Practice in Web Service Design
This document provides an overview and best practices for API design. It discusses when to build an API, such as to share data between apps or give users control over their data. It covers HTTP fundamentals like requests and responses, status codes, headers, and verbs. It also discusses different service types like RPC and RESTful services. The document provides tips on design considerations for APIs like target audience, statelessness, versioning, error handling, and access control.
4th Lecture: JSP and such
- The document discusses web technologies including Java Server Pages (JSP) and servlets.
- It describes how servlets generate dynamic web page content by running Java code that outputs HTML. Servlets are mapped to URLs via a deployment descriptor file.
- JSPs are introduced as an improvement over servlets that embeds Java code directly in HTML files, allowing clear separation of design and programming tasks. The container handles request routing and servlet lifecycle management.
Technology Stack Discussion
Zaiyang Li discusses the technology stack for a project, including the front-end framework Angular and build tools like Webpack, and the back-end framework ASP.NET Core with libraries like Dapper and testing tools like Xunit and Moq. Chart.js is used for data visualization, and a bespoke event sourcing framework is in active development to run in the same process as the web server. Protocol buffers are used for serialization and provide benefits like high performance and backward compatibility.
Web Planning an Effective Integration with a 3rd party API to Scale
The document provides tips for using web services to integrate with third parties. It discusses what web services are, how to get started with them, best practices like favoring REST over SOAP, handling errors, testing integrations, and maintaining communication with third party technical resources. The overall message is that web services require careful documentation review, testing, and collaboration to build reliable integrations at scale.
Why use Go for web development?
This document discusses the suitability of Go for web development. It notes that while Go's built-in HTML template engine is basic, the Gorazor template engine provides a more powerful way to mix Go code into HTML templates. Code generation approaches also allow Go to behave more dynamically at runtime. Go's fast compilation and use of interfaces make it well-suited for dynamic web applications and large websites. The document concludes that while other languages may be more mature, Go is suitable for developing large, stable, scalable websites that need to be maintained over time.
Saving Time By Testing With Jest
Ben McCormick gave a presentation on how to save time by testing with Jest. He began with an introduction and explained that Jest is a JavaScript testing framework developed by Facebook that aims to solve common testing problems. He then demonstrated how Jest saves time through fast setup, writing tests quickly using familiar syntax and APIs, running tests in parallel and with a smart watch mode, and providing clear errors to fix tests fast. He concluded with a demo of Jest's features and took questions.
Functional Programming in PHP
My talk about "Functional Programming in PHP" at "Freshcells System Engineering GmbH" on Oct 14, 2015
REST and ASP.NET Web API (Tunisia)
REST is an architectural style for building distributed hypermedia systems based on HTTP. The core concepts of REST include resources identified by URIs, representations of those resources exchanged via standard HTTP methods like GET, PUT, POST, and DELETE. Effective REST APIs follow architectural values like performance, scalability, loose coupling, and consistency by making resources and relationships between them accessible over HTTP. ASP.NET Web API is a framework for building RESTful services on .NET. It allows creating HTTP-based services using controllers and attributes, supports content negotiation for XML and JSON, and includes features for error handling, message handlers, dependency injection, and testing.
10 tips to make your ASP.NET Apps Faster
10 tips to make ASP.NET apps faster including:
1. Enabling kernel caching in IIS for static and dynamic content to reduce context switches.
2. Using asynchronous code, handlers, and modules to prevent thread blocking on I/O-bound operations.
3. Configuring the CLR thread pool to optimize thread usage.
4. Switching to integrated pipeline mode for a unified request processing pipeline.
5. Optimizing static file handling by selectively running managed modules.
6. Understanding the ASP.NET pipeline and placing modules strategically.
7. Avoiding direct SQL connections by using a data source.
8. Removing unused view engines to reduce overhead.
9. Avoiding
Getting Started with ASP.NET 5
This document provides an overview of getting started with ASP.NET 5. It discusses some of the key problems with previous versions of ASP.NET like long loading times and lack of cross-platform support. ASP.NET 5 addresses these issues by using a smaller core CLR, running on .NET Core which allows cross-platform deployment. It features side-by-side versioning of .NET, simplifies dependencies with NuGet, and improved request pipelines. The document demonstrates setting up a basic ASP.NET MVC 6 project and highlights how Visual Studio compiles and runs code much faster with ASP.NET 5. While Web Forms is still supported, ASP.NET 5 unites MVC and Web API into a single framework
REST APIs
This document discusses RESTful microservices and best practices for designing REST APIs. It covers topics like why REST is important for API design, common REST principles, naming conventions, resource relationships, security, versioning, documentation, and management of REST APIs. It also provides examples of how various companies implement practices like filtering, searching, paging, and error handling in their REST APIs. Finally, it discusses how the WebSphere Liberty application server supports REST APIs through features like API discovery and collective APIs.
Building rest services using aspnetwebapi
The document discusses building REST services using ASP.NET Web API. It defines REST and its constraints, and explains what ASP.NET Web API is and how it enables writing REST based services. It covers HTTP verbs, defining resources, content negotiation, and provides an example of building a simple ASP.NET Web API application.
Tech Stack Ideas
This document discusses and compares different technology stack options for building software solutions and applications. It begins by defining what a technology stack is. It then provides an overview of common layers that make up a technology stack, including web pages, web applications, data access layers, databases, and server architecture. The document goes on to compare WordPress, Drupal, and Django content management frameworks in terms of their pros and cons for different use cases. It emphasizes focusing on discovering user and business needs in order to determine the optimal technology solution.
Microsoft Azure DocumentDB - Global Azure Bootcamp 2016
Microsoft Azure DocumentDB is a fully managed NoSQL database service that supports JSON documents and SQL queries. It provides tunable consistency levels from strong to eventual, excellent search capabilities without SQL, and a REST API. Documents are stored in collections and addressed through a unique ID. Operations include CRUD and querying documents. DocumentDB also supports server-side JavaScript for stored procedures, triggers, and user-defined functions.
Automating JavaScript testing with Jasmine and Perl
This document discusses automating JavaScript testing using Jasmine and Perl. It introduces Test::WWW::Jasmine, a module that takes Jasmine test specs, runs them in a Selenium-controlled browser, and outputs the results in TAP format. This allows running JavaScript tests from Perl similar to unit tests. Examples of Jasmine test specs and TAP output are shown. The document also discusses running the same Jasmine specs locally for development. It acknowledges some limitations but seeks feedback on the new module.
Postman. From simple API test to end to end scenario
The document discusses Postman, a tool for testing APIs. It provides an overview of APIs and common API implementation approaches like SOAP and REST. It also demonstrates how Postman can be used to test APIs by creating workflows to send requests and validate responses using features like environments, variables, assertions and data-driven tests.
Automating and Testing a REST API
Have you ever wished that you had a worked example of how to test a REST API?
Not just automate the API, but how to interact with it with command line tools, and GUI tools to support your manual interactive testing. And then take your testing forward into automating the API?
That's what this book provides.
Read the 74 page sample and find out more information on the book page.
https://www.compendiumdev.co.uk/page/tracksrestapibook
The full book has over 200 pages of actual hands on case study information that can improve your testing and automating of REST API based applications.
Rest API Testing
The document discusses testing REST APIs using Java. It covers creating test cases to test API functionality, parameters, and expected results. It also discusses best practices for organizing test cases and ensuring complete test coverage. The document then describes how to perform automated testing of APIs using Java tools like POJOs, serialization/deserialization, Rest-Assured, and assertion libraries. It provides details on HTTP methods like GET, POST, PUT, DELETE and important HTTP headers.
A Day of REST
The document summarizes the New York Times' use of WordPress as a backend platform to power their live coverage and blogging needs. Some key points:
- WordPress is used to power live blogs, events, and coverage through custom post types and a Backbone admin interface that produces JSON content for front-end display.
- Migrating to the NYT5 project required refactoring WordPress to work within the new PHP framework and routing system rather than being the sole application.
- Over time the "Blogs" team transitioned to focus on WordPress and supporting interactive needs, developing new live coverage tools and responsive frontend implementations.
- REST API usage and custom endpoints were built
Rest
REST is an architectural style for building distributed systems based on HTTP. It uses HTTP verbs like GET, POST, PUT, DELETE to transfer a representation of resources between client and server. Resources are nouns that can be XML, JSON or plain text representations of real-world objects. Best practices for REST include using plural nouns for endpoints, including an API version, using HTTP verbs on endpoints, and returning appropriate HTTP response codes.
Webservices: connecting Joomla! with other programs.
This document discusses connecting Joomla! to other applications and services via web services. It describes different types of web services including XML-RPC, SOAP, and REST. XML-RPC and SOAP use remote procedure calls to call methods on a server, while REST uses HTTP methods to manipulate resources. The document provides examples of using these services with Joomla! and other applications and frameworks. It emphasizes the importance of standardizing web service connections in Joomla! using its MVC framework.
REST API Recommendations
The document provides guidelines and best practices for designing RESTful APIs, including:
- Using JSON over XML and making the API stateless and secure.
- Following conventions for HTTP verbs and status codes.
- Keeping data structures consistent and handling data with modern frameworks.
- Providing comprehensive documentation for data types, methods, and samples.
Scaling with swagger
This document discusses scaling applications and services. It recommends taking a vertical approach by breaking monolithic applications into microservices that communicate through APIs. The Swagger framework is presented as a way to document and test APIs. Swagger can generate client libraries and helps services scale by enabling asynchronous communication through websockets. Taking this vertical, microservices approach with Swagger improves scalability by allowing dedicated teams to own individual services and improves performance through asynchronous communication protocols.
API Docs with OpenAPI 3.0
The document provides an introduction and overview of APIs, REST, and OpenAPI specification. It discusses key concepts like resources, HTTP verbs, and OpenAPI structure. It also demonstrates OpenAPI syntax using JSON and YAML examples and highlights best practices for documenting APIs with OpenAPI.
RESTful Services
The document discusses REST (REpresentational State Transfer), the architectural style for distributed hypermedia systems. It covers the six constraints of REST - uniform interface, stateless, cacheable, client-server, layered system, and code-on-demand. Other topics include uniform interfaces using resources and HTTP verbs, hypermedia and HATEOAS, versioning, media types, HTTP response codes, and best practices for building RESTful APIs. Roy Fielding's dissertation on REST architecture is cited as the origin of the REST concepts.
Api fundamentals
Applications increasingly talk to each other behind the scenes via APIs. Google’s recent acquisition of Apigee, an API management company, is an indicator of the continued importance of APIs. APIs are like building blocks, providing services and data that can be connected with other APIs to build powerful customized apps. However, developing and testing an API can be challenging because there is no built-in interface, breaking changes can cause widespread outages, sensitive data may be exposed or accessed, and accepted agile testing paradigms can be difficult to adapt to APIs. This session is an introduction to restful APIs and how to test them for security, performance, functionality, and backwards-compatibility risks.
Api FUNdamentals #MHA2017
- The document introduces APIs and provides an overview of what they are, how they work, and strategies for testing APIs.
- It discusses RESTful principles, how HTTP requests and responses work, authentication methods like OAuth and JWT, and tools for testing APIs like Postman.
- Examples are given around making GET and POST requests to APIs and checking the status and response to demonstrate how APIs can be interacted with and tested.
More Related Content
What's hot
Saving Time By Testing With Jest
Ben McCormick gave a presentation on how to save time by testing with Jest. He began with an introduction and explained that Jest is a JavaScript testing framework developed by Facebook that aims to solve common testing problems. He then demonstrated how Jest saves time through fast setup, writing tests quickly using familiar syntax and APIs, running tests in parallel and with a smart watch mode, and providing clear errors to fix tests fast. He concluded with a demo of Jest's features and took questions.
Functional Programming in PHP
My talk about "Functional Programming in PHP" at "Freshcells System Engineering GmbH" on Oct 14, 2015
REST and ASP.NET Web API (Tunisia)
REST is an architectural style for building distributed hypermedia systems based on HTTP. The core concepts of REST include resources identified by URIs, representations of those resources exchanged via standard HTTP methods like GET, PUT, POST, and DELETE. Effective REST APIs follow architectural values like performance, scalability, loose coupling, and consistency by making resources and relationships between them accessible over HTTP. ASP.NET Web API is a framework for building RESTful services on .NET. It allows creating HTTP-based services using controllers and attributes, supports content negotiation for XML and JSON, and includes features for error handling, message handlers, dependency injection, and testing.
10 tips to make your ASP.NET Apps Faster
10 tips to make ASP.NET apps faster including:
1. Enabling kernel caching in IIS for static and dynamic content to reduce context switches.
2. Using asynchronous code, handlers, and modules to prevent thread blocking on I/O-bound operations.
3. Configuring the CLR thread pool to optimize thread usage.
4. Switching to integrated pipeline mode for a unified request processing pipeline.
5. Optimizing static file handling by selectively running managed modules.
6. Understanding the ASP.NET pipeline and placing modules strategically.
7. Avoiding direct SQL connections by using a data source.
8. Removing unused view engines to reduce overhead.
9. Avoiding
Getting Started with ASP.NET 5
This document provides an overview of getting started with ASP.NET 5. It discusses some of the key problems with previous versions of ASP.NET like long loading times and lack of cross-platform support. ASP.NET 5 addresses these issues by using a smaller core CLR, running on .NET Core which allows cross-platform deployment. It features side-by-side versioning of .NET, simplifies dependencies with NuGet, and improved request pipelines. The document demonstrates setting up a basic ASP.NET MVC 6 project and highlights how Visual Studio compiles and runs code much faster with ASP.NET 5. While Web Forms is still supported, ASP.NET 5 unites MVC and Web API into a single framework
REST APIs
This document discusses RESTful microservices and best practices for designing REST APIs. It covers topics like why REST is important for API design, common REST principles, naming conventions, resource relationships, security, versioning, documentation, and management of REST APIs. It also provides examples of how various companies implement practices like filtering, searching, paging, and error handling in their REST APIs. Finally, it discusses how the WebSphere Liberty application server supports REST APIs through features like API discovery and collective APIs.
Building rest services using aspnetwebapi
The document discusses building REST services using ASP.NET Web API. It defines REST and its constraints, and explains what ASP.NET Web API is and how it enables writing REST based services. It covers HTTP verbs, defining resources, content negotiation, and provides an example of building a simple ASP.NET Web API application.
Tech Stack Ideas
This document discusses and compares different technology stack options for building software solutions and applications. It begins by defining what a technology stack is. It then provides an overview of common layers that make up a technology stack, including web pages, web applications, data access layers, databases, and server architecture. The document goes on to compare WordPress, Drupal, and Django content management frameworks in terms of their pros and cons for different use cases. It emphasizes focusing on discovering user and business needs in order to determine the optimal technology solution.
Microsoft Azure DocumentDB - Global Azure Bootcamp 2016
Microsoft Azure DocumentDB is a fully managed NoSQL database service that supports JSON documents and SQL queries. It provides tunable consistency levels from strong to eventual, excellent search capabilities without SQL, and a REST API. Documents are stored in collections and addressed through a unique ID. Operations include CRUD and querying documents. DocumentDB also supports server-side JavaScript for stored procedures, triggers, and user-defined functions.
Automating JavaScript testing with Jasmine and Perl
This document discusses automating JavaScript testing using Jasmine and Perl. It introduces Test::WWW::Jasmine, a module that takes Jasmine test specs, runs them in a Selenium-controlled browser, and outputs the results in TAP format. This allows running JavaScript tests from Perl similar to unit tests. Examples of Jasmine test specs and TAP output are shown. The document also discusses running the same Jasmine specs locally for development. It acknowledges some limitations but seeks feedback on the new module.
Postman. From simple API test to end to end scenario
The document discusses Postman, a tool for testing APIs. It provides an overview of APIs and common API implementation approaches like SOAP and REST. It also demonstrates how Postman can be used to test APIs by creating workflows to send requests and validate responses using features like environments, variables, assertions and data-driven tests.
Automating and Testing a REST API
Have you ever wished that you had a worked example of how to test a REST API?
Not just automate the API, but how to interact with it with command line tools, and GUI tools to support your manual interactive testing. And then take your testing forward into automating the API?
That's what this book provides.
Read the 74 page sample and find out more information on the book page.
https://www.compendiumdev.co.uk/page/tracksrestapibook
The full book has over 200 pages of actual hands on case study information that can improve your testing and automating of REST API based applications.
Rest API Testing
The document discusses testing REST APIs using Java. It covers creating test cases to test API functionality, parameters, and expected results. It also discusses best practices for organizing test cases and ensuring complete test coverage. The document then describes how to perform automated testing of APIs using Java tools like POJOs, serialization/deserialization, Rest-Assured, and assertion libraries. It provides details on HTTP methods like GET, POST, PUT, DELETE and important HTTP headers.
A Day of REST
The document summarizes the New York Times' use of WordPress as a backend platform to power their live coverage and blogging needs. Some key points:
- WordPress is used to power live blogs, events, and coverage through custom post types and a Backbone admin interface that produces JSON content for front-end display.
- Migrating to the NYT5 project required refactoring WordPress to work within the new PHP framework and routing system rather than being the sole application.
- Over time the "Blogs" team transitioned to focus on WordPress and supporting interactive needs, developing new live coverage tools and responsive frontend implementations.
- REST API usage and custom endpoints were built
Rest
REST is an architectural style for building distributed systems based on HTTP. It uses HTTP verbs like GET, POST, PUT, DELETE to transfer a representation of resources between client and server. Resources are nouns that can be XML, JSON or plain text representations of real-world objects. Best practices for REST include using plural nouns for endpoints, including an API version, using HTTP verbs on endpoints, and returning appropriate HTTP response codes.
Webservices: connecting Joomla! with other programs.
This document discusses connecting Joomla! to other applications and services via web services. It describes different types of web services including XML-RPC, SOAP, and REST. XML-RPC and SOAP use remote procedure calls to call methods on a server, while REST uses HTTP methods to manipulate resources. The document provides examples of using these services with Joomla! and other applications and frameworks. It emphasizes the importance of standardizing web service connections in Joomla! using its MVC framework.
What's hot (16)
Microsoft Azure DocumentDB - Global Azure Bootcamp 2016
Microsoft Azure DocumentDB - Global Azure Bootcamp 2016
Automating JavaScript testing with Jasmine and Perl
Automating JavaScript testing with Jasmine and Perl
Postman. From simple API test to end to end scenario
Postman. From simple API test to end to end scenario
Webservices: connecting Joomla! with other programs.
Webservices: connecting Joomla! with other programs.
Similar to Api crash
REST API Recommendations
The document provides guidelines and best practices for designing RESTful APIs, including:
- Using JSON over XML and making the API stateless and secure.
- Following conventions for HTTP verbs and status codes.
- Keeping data structures consistent and handling data with modern frameworks.
- Providing comprehensive documentation for data types, methods, and samples.
Scaling with swagger
This document discusses scaling applications and services. It recommends taking a vertical approach by breaking monolithic applications into microservices that communicate through APIs. The Swagger framework is presented as a way to document and test APIs. Swagger can generate client libraries and helps services scale by enabling asynchronous communication through websockets. Taking this vertical, microservices approach with Swagger improves scalability by allowing dedicated teams to own individual services and improves performance through asynchronous communication protocols.
API Docs with OpenAPI 3.0
The document provides an introduction and overview of APIs, REST, and OpenAPI specification. It discusses key concepts like resources, HTTP verbs, and OpenAPI structure. It also demonstrates OpenAPI syntax using JSON and YAML examples and highlights best practices for documenting APIs with OpenAPI.
RESTful Services
The document discusses REST (REpresentational State Transfer), the architectural style for distributed hypermedia systems. It covers the six constraints of REST - uniform interface, stateless, cacheable, client-server, layered system, and code-on-demand. Other topics include uniform interfaces using resources and HTTP verbs, hypermedia and HATEOAS, versioning, media types, HTTP response codes, and best practices for building RESTful APIs. Roy Fielding's dissertation on REST architecture is cited as the origin of the REST concepts.
Api fundamentals
Applications increasingly talk to each other behind the scenes via APIs. Google’s recent acquisition of Apigee, an API management company, is an indicator of the continued importance of APIs. APIs are like building blocks, providing services and data that can be connected with other APIs to build powerful customized apps. However, developing and testing an API can be challenging because there is no built-in interface, breaking changes can cause widespread outages, sensitive data may be exposed or accessed, and accepted agile testing paradigms can be difficult to adapt to APIs. This session is an introduction to restful APIs and how to test them for security, performance, functionality, and backwards-compatibility risks.
Api FUNdamentals #MHA2017
- The document introduces APIs and provides an overview of what they are, how they work, and strategies for testing APIs.
- It discusses RESTful principles, how HTTP requests and responses work, authentication methods like OAuth and JWT, and tools for testing APIs like Postman.
- Examples are given around making GET and POST requests to APIs and checking the status and response to demonstrate how APIs can be interacted with and tested.
ASP.NET Mvc 4 web api
This document provides an overview of ASP.NET MVC 4 Web API. It discusses what an API is and why Web API is used. It covers key concepts like HTTP, REST, JSON. It describes features of Web API like routing, error handling, model validation, OData support, media formatters, and security. It also discusses using the HttpClient class and future plans.
Rest APIs Training
This document provides an overview of RESTful APIs and related concepts:
- It describes HTTP methods like GET, POST, PUT, DELETE and PATCH that are used to interact with resources over HTTP.
- It explains HTTP status codes for success (2xx), client errors (4xx) and server errors (5xx).
- It discusses REST architectural constraints like client-server, statelessness, caching, uniform interface, content negotiation and hypermedia.
- It covers concepts like resources, URIs, relationships between resources, content negotiation, versioning APIs, and HATEOAS to make APIs self-descriptive.
Restful风格web服务架构
This document provides an overview of REST (Representational State Transfer) and RESTful architectures. It begins with an introduction and agenda. It then defines REST and describes its key aspects like resources, representations, and the HTTP methods. It discusses the constraints and goals of REST, examples of RESTful systems, and why REST is advantageous for building distributed systems. Finally, it covers implementing RESTful services in Java using the JAX-RS API and frameworks like Jersey.
Build Modern Web Apps Using ASP.NET Web API and AngularJS
Slides shows the latest trends used in building RESTful API using ASP.NET Web API and how to build SPA using AngularJS which talks to those RESTful APIs
Php internal architecture
The internal structure of PHP and how it affects deployment, usage, and extensibility both now and in the future
Advanced Web Development in PHP - Understanding REST API
ESOFT Metro Campus - Advanced Web Development in PHP - (Module VIII) Understanding REST API
(Template - Virtusa Corporate)
Resources: codeofaninja.com
Contents:
What is an API?
Comparing a website to an API
Classification of APIs
What is REST API?
What model does REST use?
REST HTTP Methods
HTTP Codes
The advantages of REST
What is CRUD?
CRUD Operations
CRUD Application Example
Simple REST API Implementation in PHP
Web root Folders and Files Structure
MySQL Database
Reading all Products
Reading one Product
Creating a Product
Updating a Product
Deleting a Product
Searching a Product
CNIT 129S: Ch 3: Web Application Technologies
Slides for a college course based on "The Web Application Hacker's Handbook", 2nd Ed.
Teacher: Sam Bowne
Website: https://samsclass.info/129S/129S_F16.shtml
Api 101
API 101 provides an introduction to APIs and related concepts:
APIs expose useful data and functionality for developers to consume in their own programs. They allow different systems to communicate through standardized interfaces and protocols. The document discusses REST APIs and compares architectural styles like RPC, covering topics such as HTTP methods, URI design, and authentication. It examines challenges in API design like versioning, security, and avoiding unnecessary data transfers.
Best Practices in Web Service Design
The document discusses best practices for designing web services. It covers using HTTP as a protocol, different service types like SOAP, XML-RPC and REST, and considerations for designing APIs like making them stateless, versioning, error handling and authentication. The document emphasizes keeping services small, consistent and well documented with examples to empower users.
Intro to CakePHP
CakePHP is a modern PHP framework that aims to reduce development time and promote rapid application development. It takes a convention over configuration approach and encourages best practices like DRY coding. CakePHP has an active community that provides support through forums, Slack, IRC and meetups. The framework continues to evolve through new releases that bring additional features while maintaining backwards compatibility.
Web Application Development using PHP Chapter 1
Here are the solutions to the equations given in the quiz:
a) $x + $x + $y = 10 + 10 + 5 = 25
b) $x - $y + $x = 10 - 5 + 10 = 15
c) $x + $y * $x = 10 + 5 * 10 = 10 + 50 = 60
d) $x / $y + $x = 10 / 5 + 10 = 2 + 10 = 12
e) $x > $y = 10 > 5 = True
f) $y != $x = 5 != 10 = True
g) ++$x = 11
h) $y-- = 4
CNIT 129S - Ch 3: Web Application Technologies
For a college course at CCSF taught by Sam Bowne.
https://samsclass.info/129S/129S_S18.shtml
Based on "The Web Application Hacker's Handbook: Finding and Exploiting Security Flaws 2nd Edition", by Dafydd Stuttard , Marcus Pinto; ISBN-10: 1118026470
Middleware in Golang: InVision's Rye
InVision is a collaborative design company that’s growing into Golang. That being said, when we started doing web services, we looked at using one of the middleware libraries out there such as Alice and Negroni. We found them all interesting but decided to tackle it on our own. As we did that we realized that our library was pretty cool so we broke it out and open sourced it as Rye. I’ll present on the approach we took and some of the benefits of using Rye including integration with Statsd, Context and custom middleware handlers we’ve added such as CIDR validation and JWT validation.
Introduction to the Web API
The document provides an introduction to web APIs and REST. It defines APIs as methods to access data and workflows from an application without using the application itself. It describes REST as an architectural style for APIs that uses a client-server model with stateless operations and a uniform interface. The document outlines best practices for REST APIs, including using HTTP verbs like GET, POST, PUT and DELETE to perform CRUD operations on resources identified by URIs. It also discusses authentication, authorization, security concerns and gives examples of popular REST APIs from Facebook, Twitter and other services.
Similar to Api crash (20)
Build Modern Web Apps Using ASP.NET Web API and AngularJS
Build Modern Web Apps Using ASP.NET Web API and AngularJS
Advanced Web Development in PHP - Understanding REST API
Advanced Web Development in PHP - Understanding REST API
More from Luis Goldster
Ruby on rails evaluation
Ruby on Rails provides a default model-view-controller design and generators that apply progressive evaluation and domain correspondence. The code completion in the IDE and Ruby language has issues with penetrability. Migrations offer a high-level abstraction for data modeling through specialized Ruby files that are invertible and treat objects rather than records. Rails leverages the dynamic Ruby language to provide good domain correspondence, progressive evaluation, and abstraction level, though it is missing error prevention due to the dynamic approach.
Design patterns
This document discusses several design patterns including Singleton, Observer, Delegation, Adapter, Facade, Immutable, Read-Only Interface, Proxy, and Factory. For each pattern, the document describes the context, problem, forces, and solution. The patterns provide reusable solutions to common programming problems by separating interfaces from implementations.
Lisp and scheme i
Lisp and Scheme are dialects of the Lisp programming language. Scheme is favored for teaching due to its simplicity. Key features of Lisp include S-expressions as the universal data type, functional programming style with first-class functions, and uniform representation of code and data. Functions are defined using DEFINE and special forms like IF and COND control program flow. Common list operations include functions like CAR, CDR, CONS, LIST, and REVERSE.
Ado.net & data persistence frameworks
The document discusses serialization, ADO.NET, data tier approaches, and persistence frameworks. Serialization allows persisting an object's state to storage and recreating it later. ADO.NET provides classes for connecting to and interacting with databases. Common data tier approaches include presenting data directly to the presentation layer, adding a business logic layer, or adding a service layer between business logic and data access. Persistence frameworks aim to simplify data access by encapsulating object persistence behaviors like reading, writing, and deleting objects from storage.
Multithreading models.ppt
The document discusses three common multithreading models: many-to-one, one-to-one, and many-to-many. It also describes common high-level program structures for multithreaded programs like the boss/workers model, pipeline model, up-calls, and using version stamps to keep shared information consistent.
Business analytics and data mining
The document provides an overview of business analytics (BA) including its history, types, examples, challenges, and relationship to data mining. BA involves exploring past business performance data to gain insights and guide planning. It can focus on specific business segments. Types of BA include reporting, affinity grouping, clustering, and predictive analytics. Challenges to BA include acquiring high quality data and rapidly processing large volumes of data. Data mining is an important part of BA, helping to sort and analyze large datasets.
Big picture of data mining
This document discusses decision trees and how they are constructed. It begins by explaining that decision trees use supervised learning to generate classification rules by splitting a training dataset based on attribute values. It then walks through an example of constructing a decision tree for predicting voter support based on attributes like age, income, education level, etc. The document discusses that the optimal way to construct a decision tree is NP-complete, so heuristics like information gain are used to choose the best attribute to split on at each node to minimize complexity. It concludes by adding a new social security number attribute and explaining that information gain would not choose to split on this attribute.
Data mining and knowledge discovery
The document discusses data mining and knowledge discovery from large datasets. It begins by defining the hierarchy from data to wisdom. It then discusses the growth of big data from various sources and the need for data mining to extract useful knowledge. Data mining involves applying machine learning, statistics, visualization and database techniques to discover patterns in large datasets. The knowledge discovery process involves data cleaning, transformation, data mining and evaluating/interpreting patterns. The document provides examples of data mining applications in business, fraud detection, text mining and web mining.
Cache recap
The document discusses memory hierarchy and caching techniques. It begins by explaining the need for a memory hierarchy due to differing access times of memory technologies like SRAM, DRAM, and disk. It then covers concepts like cache hits, misses, block size, direct mapping, set associativity, compulsory misses, capacity misses, and conflict misses. Finally, it discusses using a second-level cache to reduce memory access times by capturing misses from the first-level cache.
Directory based cache coherence
The document discusses non-uniform cache architectures (NUCA), cache coherence, and different implementations of directories in multicore systems. It describes NUCA designs that map data to banks based on distance from the controller to exploit non-uniform access times. Cache coherence is maintained using directory-based protocols that track copies of cache blocks. Directories can be implemented off-chip in DRAM or on-chip using duplicate tag stores or distributing the directory among cache banks. Examples of systems like SGI Origin2000 and Tilera Tile64 that use these techniques are also outlined.
Hardware managed cache
The document proposes optimizing DRAM caches for latency rather than hit rate. It summarizes previous work on DRAM caches like Loh-Hill Cache that treated DRAM cache similarly to SRAM cache. This led to high latency and low bandwidth utilization.
The document introduces the Alloy Cache design which avoids tag serialization to reduce latency. It also proposes a Memory Access Predictor to selectively use parallel or serial access models for low latency and bandwidth. Simulation results show Alloy Cache with a predictor outperforms previous designs like SRAM-tag caches. The design provides benefits with simple structures optimized for DRAM cache constraints.
How analysis services caching works
This document discusses how Analysis Services caching works and provides strategies for warming the Storage Engine cache and Formula Engine cache. It explains that the Storage Engine handles data retrieval from disk while the Formula Engine determines which data is needed for queries. Caching can improve performance but requires understanding when Analysis Services is unable to cache data. The document recommends using the CREATE CACHE statement and running regular queries to pre-populate the caches with commonly used data. Memory usage must also be considered when warming the caches.
Abstract data types
This document discusses abstract data types (ADTs) and their implementation in various programming languages. It covers the key concepts of ADTs including data abstraction, encapsulation, information hiding, and defining the public interface separately from the private implementation. It provides examples of ADTs implemented using modules in Modula-2, packages in Ada, classes in C++, generics in Java and C#, and classes in Ruby. Parameterized and encapsulation constructs are also discussed as techniques for implementing and organizing ADTs.
Optimizing shared caches in chip multiprocessors
Chip multiprocessors, which place multiple processors on a single chip, have become common in modern processors. There are different approaches to managing caches in chip multiprocessors, including private caches for each processor or shared caches. The optimal approach balances factors like interconnect traffic, duplication of data, load balancing, and cache hit rates. Recent research explores techniques like cooperative caching between private caches and adaptive set pinning in shared caches.
Object model
The document discusses abstraction, which is a fundamental concept of object-oriented design. Abstraction involves focusing on an object's essential characteristics and behavior while hiding implementation details. There are different types of abstractions from most useful to least useful. Effective abstractions model real-world entities and provide well-defined interfaces through contracts, preconditions, and postconditions. Both static and dynamic properties of objects must be considered.
Abstraction file
This document discusses the key concepts of object-oriented programming including abstraction, encapsulation, classes and objects. It defines abstraction as focusing on the essential characteristics of an object and hiding unnecessary details. Encapsulation hides the internal representation of an object within its public interface. A class combines both abstraction and encapsulation, defining the data and operations of an object. Objects are instantiations of classes that are initialized via constructors and cleaned up via destructors.
Object oriented analysis
Object-oriented analysis and design (OOAD) emphasizes investigating requirements rather than solutions, and conceptual solutions that fulfill requirements rather than implementations. OOAD focuses on identifying domain concepts and defining software objects and how they collaborate. The Unified Process includes inception, elaboration, construction, and transition phases with iterations and milestones leading to final product releases.
Abstract class
Abstract classes and interfaces allow for abstraction and polymorphism in object-oriented design. Abstract classes can contain both abstract and concrete methods, while interfaces only contain abstract methods. Abstract classes are used to provide a common definition for subclasses through inheritance, while interfaces define a contract for implementing classes to follow. Both support polymorphism by allowing subclasses/implementing classes to determine the specific implementation for abstract methods.
Concurrency with java
This document discusses various programming paradigms and concurrency concepts in Java. It covers single process and multi-process programming, as well as multi-core and multi-threaded programming. The document also discusses processes, threads, synchronization, deadlocks, and strategies for designing objects to be thread-safe such as immutability, locking, and splitting state.
Data structures and algorithms
The document discusses abstract data types (ADTs), specifically queues. It defines a queue as a linear collection where elements are added to one end and removed from the other end, following a first-in, first-out (FIFO) approach. The key queue operations are enqueue, which adds an element, and dequeue, which removes the element that has been in the queue longest. Queues can be implemented using arrays or linked lists. Array implementations use head and tail pointers to track the start and end of the queue.
More from Luis Goldster (20)
Recently uploaded
Taking AI to the Next Level in Manufacturing.pdf
Read Taking AI to the Next Level in Manufacturing to gain insights on AI adoption in the manufacturing industry, such as:
1. How quickly AI is being implemented in manufacturing.
2. Which barriers stand in the way of AI adoption.
3. How data quality and governance form the backbone of AI.
4. Organizational processes and structures that may inhibit effective AI adoption.
6. Ideas and approaches to help build your organization's AI strategy.
Webinar: Designing a schema for a Data Warehouse
Are you new to data warehouses (DWH)? Do you need to check whether your data warehouse follows the best practices for a good design? In both cases, this webinar is for you.
A data warehouse is a central relational database that contains all measurements about a business or an organisation. This data comes from a variety of heterogeneous data sources, which includes databases of any type that back the applications used by the company, data files exported by some applications, or APIs provided by internal or external services.
But designing a data warehouse correctly is a hard task, which requires gathering information about the business processes that need to be analysed in the first place. These processes must be translated into so-called star schemas, which means, denormalised databases where each table represents a dimension or facts.
We will discuss these topics:
- How to gather information about a business;
- Understanding dictionaries and how to identify business entities;
- Dimensions and facts;
- Setting a table granularity;
- Types of facts;
- Types of dimensions;
- Snowflakes and how to avoid them;
- Expanding existing dimensions and facts.
AI 101: An Introduction to the Basics and Impact of Artificial Intelligence
Imagine a world where machines not only perform tasks but also learn, adapt, and make decisions. This is the promise of Artificial Intelligence (AI), a technology that's not just enhancing our lives but revolutionizing entire industries.
Presentation of the OECD Artificial Intelligence Review of Germany
Consult the full report at https://www.oecd.org/digital/oecd-artificial-intelligence-review-of-germany-609808d6-en.htm
Generating privacy-protected synthetic data using Secludy and Milvus
During this demo, the founders of Secludy will demonstrate how their system utilizes Milvus to store and manipulate embeddings for generating privacy-protected synthetic data. Their approach not only maintains the confidentiality of the original data but also enhances the utility and scalability of LLMs under privacy constraints. Attendees, including machine learning engineers, data scientists, and data managers, will witness first-hand how Secludy's integration with Milvus empowers organizations to harness the power of LLMs securely and efficiently.
Building Production Ready Search Pipelines with Spark and Milvus
Spark is the widely used ETL tool for processing, indexing and ingesting data to serving stack for search. Milvus is the production-ready open-source vector database. In this talk we will show how to use Spark to process unstructured data to extract vector representations, and push the vectors to Milvus vector database for search serving.
Programming Foundation Models with DSPy - Meetup Slides
Prompting language models is hard, while programming language models is easy. In this talk, I will discuss the state-of-the-art framework DSPy for programming foundation models with its powerful optimizers and runtime constraint system.
Columbus Data & Analytics Wednesdays - June 2024
Columbus Data & Analytics Wednesdays, June 2024 with Maria Copot 20
Digital Marketing Trends in 2024 | Guide for Staying Ahead
https://www.wask.co/ebooks/digital-marketing-trends-in-2024
Feeling lost in the digital marketing whirlwind of 2024? Technology is changing, consumer habits are evolving, and staying ahead of the curve feels like a never-ending pursuit. This e-book is your compass. Dive into actionable insights to handle the complexities of modern marketing. From hyper-personalization to the power of user-generated content, learn how to build long-term relationships with your audience and unlock the secrets to success in the ever-shifting digital landscape.
Salesforce Integration for Bonterra Impact Management (fka Social Solutions A...
Sidekick Solutions uses Bonterra Impact Management (fka Social Solutions Apricot) and automation solutions to integrate data for business workflows.
We believe integration and automation are essential to user experience and the promise of efficient work through technology. Automation is the critical ingredient to realizing that full vision. We develop integration products and services for Bonterra Case Management software to support the deployment of automations for a variety of use cases.
This video focuses on integration of Salesforce with Bonterra Impact Management.
Interested in deploying an integration with Salesforce for Bonterra Impact Management? Contact us at sales@sidekicksolutionsllc.com to discuss next steps.
Let's Integrate MuleSoft RPA, COMPOSER, APM with AWS IDP along with Slack
Discover the seamless integration of RPA (Robotic Process Automation), COMPOSER, and APM with AWS IDP enhanced with Slack notifications. Explore how these technologies converge to streamline workflows, optimize performance, and ensure secure access, all while leveraging the power of AWS IDP and real-time communication via Slack notifications.
Fueling AI with Great Data with Airbyte Webinar
This talk will focus on how to collect data from a variety of sources, leveraging this data for RAG and other GenAI use cases, and finally charting your course to productionalization.
Cosa hanno in comune un mattoncino Lego e la backdoor XZ?
ABSTRACT: A prima vista, un mattoncino Lego e la backdoor XZ potrebbero avere in comune il fatto di essere entrambi blocchi di costruzione, o dipendenze di progetti creativi e software. La realtà è che un mattoncino Lego e il caso della backdoor XZ hanno molto di più di tutto ciò in comune.
Partecipate alla presentazione per immergervi in una storia di interoperabilità, standard e formati aperti, per poi discutere del ruolo importante che i contributori hanno in una comunità open source sostenibile.
BIO: Sostenitrice del software libero e dei formati standard e aperti. È stata un membro attivo dei progetti Fedora e openSUSE e ha co-fondato l'Associazione LibreItalia dove è stata coinvolta in diversi eventi, migrazioni e formazione relativi a LibreOffice. In precedenza ha lavorato a migrazioni e corsi di formazione su LibreOffice per diverse amministrazioni pubbliche e privati. Da gennaio 2020 lavora in SUSE come Software Release Engineer per Uyuni e SUSE Manager e quando non segue la sua passione per i computer e per Geeko coltiva la sua curiosità per l'astronomia (da cui deriva il suo nickname deneb_alpha).
Main news related to the CCS TSI 2023 (2023/1695)
An English 🇬🇧 translation of a presentation to the speech I gave about the main changes brought by CCS TSI 2023 at the biggest Czech conference on Communications and signalling systems on Railways, which was held in Clarion Hotel Olomouc from 7th to 9th November 2023 (konferenceszt.cz). Attended by around 500 participants and 200 on-line followers.
The original Czech 🇨🇿 version of the presentation can be found here: https://www.slideshare.net/slideshow/hlavni-novinky-souvisejici-s-ccs-tsi-2023-2023-1695/269688092 .
The videorecording (in Czech) from the presentation is available here: https://youtu.be/WzjJWm4IyPk?si=SImb06tuXGb30BEH .
Energy Efficient Video Encoding for Cloud and Edge Computing Instances
Energy Efficient Video Encoding for Cloud and Edge Computing Instances
June Patch Tuesday
Ivanti’s Patch Tuesday breakdown goes beyond patching your applications and brings you the intelligence and guidance needed to prioritize where to focus your attention first. Catch early analysis on our Ivanti blog, then join industry expert Chris Goettl for the Patch Tuesday Webinar Event. There we’ll do a deep dive into each of the bulletins and give guidance on the risks associated with the newly-identified vulnerabilities.
Monitoring and Managing Anomaly Detection on OpenShift.pdf
Monitoring and Managing Anomaly Detection on OpenShift
Overview
Dive into the world of anomaly detection on edge devices with our comprehensive hands-on tutorial. This SlideShare presentation will guide you through the entire process, from data collection and model training to edge deployment and real-time monitoring. Perfect for those looking to implement robust anomaly detection systems on resource-constrained IoT/edge devices.
Key Topics Covered
1. Introduction to Anomaly Detection
- Understand the fundamentals of anomaly detection and its importance in identifying unusual behavior or failures in systems.
2. Understanding Edge (IoT)
- Learn about edge computing and IoT, and how they enable real-time data processing and decision-making at the source.
3. What is ArgoCD?
- Discover ArgoCD, a declarative, GitOps continuous delivery tool for Kubernetes, and its role in deploying applications on edge devices.
4. Deployment Using ArgoCD for Edge Devices
- Step-by-step guide on deploying anomaly detection models on edge devices using ArgoCD.
5. Introduction to Apache Kafka and S3
- Explore Apache Kafka for real-time data streaming and Amazon S3 for scalable storage solutions.
6. Viewing Kafka Messages in the Data Lake
- Learn how to view and analyze Kafka messages stored in a data lake for better insights.
7. What is Prometheus?
- Get to know Prometheus, an open-source monitoring and alerting toolkit, and its application in monitoring edge devices.
8. Monitoring Application Metrics with Prometheus
- Detailed instructions on setting up Prometheus to monitor the performance and health of your anomaly detection system.
9. What is Camel K?
- Introduction to Camel K, a lightweight integration framework built on Apache Camel, designed for Kubernetes.
10. Configuring Camel K Integrations for Data Pipelines
- Learn how to configure Camel K for seamless data pipeline integrations in your anomaly detection workflow.
11. What is a Jupyter Notebook?
- Overview of Jupyter Notebooks, an open-source web application for creating and sharing documents with live code, equations, visualizations, and narrative text.
12. Jupyter Notebooks with Code Examples
- Hands-on examples and code snippets in Jupyter Notebooks to help you implement and test anomaly detection models.
How to Get CNIC Information System with Paksim Ga.pptx
Pakdata Cf is a groundbreaking system designed to streamline and facilitate access to CNIC information. This innovative platform leverages advanced technology to provide users with efficient and secure access to their CNIC details.
Recently uploaded (20)
AI 101: An Introduction to the Basics and Impact of Artificial Intelligence
AI 101: An Introduction to the Basics and Impact of Artificial Intelligence
Presentation of the OECD Artificial Intelligence Review of Germany
Presentation of the OECD Artificial Intelligence Review of Germany
Generating privacy-protected synthetic data using Secludy and Milvus
Generating privacy-protected synthetic data using Secludy and Milvus
Building Production Ready Search Pipelines with Spark and Milvus
Building Production Ready Search Pipelines with Spark and Milvus
Programming Foundation Models with DSPy - Meetup Slides
Programming Foundation Models with DSPy - Meetup Slides
Digital Marketing Trends in 2024 | Guide for Staying Ahead
Digital Marketing Trends in 2024 | Guide for Staying Ahead
Salesforce Integration for Bonterra Impact Management (fka Social Solutions A...
Salesforce Integration for Bonterra Impact Management (fka Social Solutions A...
Let's Integrate MuleSoft RPA, COMPOSER, APM with AWS IDP along with Slack
Let's Integrate MuleSoft RPA, COMPOSER, APM with AWS IDP along with Slack
Cosa hanno in comune un mattoncino Lego e la backdoor XZ?
Cosa hanno in comune un mattoncino Lego e la backdoor XZ?
Energy Efficient Video Encoding for Cloud and Edge Computing Instances
Energy Efficient Video Encoding for Cloud and Edge Computing Instances
Monitoring and Managing Anomaly Detection on OpenShift.pdf
Monitoring and Managing Anomaly Detection on OpenShift.pdf
How to Get CNIC Information System with Paksim Ga.pptx
How to Get CNIC Information System with Paksim Ga.pptx
Api crash
- 1. OUTLINE • What is an API? • Why are API’s useful? • What is HTTP? JSON? XML? • What is a RESTful API? • How do we consume an API? • How do we create an API? API’s are available from many large websites and businesses
- 2. WHAT IS AN API? • API = Application Programming Interface • You use API’s all the time. Scanner class Java • Web API: A set of methods exposed over the web via HTTP to allow programmatic access to applications. • Allows you to quickly add functionality/data that others have created. • Very similar to how a web page works
- 3. WHY API’S ARE USEFUL • Abstraction / DRY Principle • Less data transfer • Can be implemented or consumed in almost any language • Can expose some methods to public developers • Allows frontend developers and backend developers to agree on a common interface
- 4. HTTP, JSON, XML • Three important technologies that are often used by API’s • HTTP: Hyper text transfer protocol, transfers data over a network • GET : Read • POST : Create • PUT : Update • PATCH : Partial Update • DELETE : Delete • JSON: JavaScript Object Notation, a format for data transfer • {“key”: “value”, “key2”:{“subkey”: 2, “error”: false}} • XML: EXtensible Markup Language: a format for data transfer • Designed to be human and machine readable <?PHP json_decode(‘{“key”:true}’); ?>
- 5. WHAT IS A RESTFUL API? • Uniform Interface • Resources (Nouns) URI’s that HTTP Verbs act on. The uniform interface allows Client / Server to evolve independently. • Stateless • Ever have back button issues? Stateless does not care what order requests are made in. • Cacheable • Client-Server • Separation, client should not manage database, server should not manage UI. • Layered System • Can uses layered system, cache, middle ware, load balancing, redundancy etc. https://api.example.com/v1/resource/identifier/relation?filtersortParams=value GitHub's API lets you star a gist with PUT /gists/:id/star and unstar with DELETE /gists/:id/star.
- 6. HOW TO CONSUME AN API • Firefox: RESTClient • Chrome: Postman • Online: https://www.hurl.it/ • Examples: • http://nflarrest.com/api/v1/team • http://buscentral.herokuapp.com/suggestions POST (Feedback, message) or GET • https://www.youtube.com/watch?v=suHY8dLKzCU
- 7. HOW DO DESIGN AN API • Gather requirements from stakeholders • Create use cases, and decide the functionality needed • Think skeptically, make sure you explore your options • Think ahead, make a flexible system • Easy To learn and use, even without documentation • Hard to misuse • Easy to read and maintain code that uses it • Sufficiently powerful to satisfy requirements and Appropriate to audience • Easy to evolve (Use arrays for example) Rules for a good API
- 8. CREATING A SIMPLE API • You can use any hostable language with a HTTP library (Almost all of them) • Decide your resources, then decide the verbs. • Useful to wireframe the UI at this stage • Connect to persistent data store • Remember the principles of REST • Example in Node.JS: https://github.com/PatrickMurphy/VoteSmart
- 9. ADVANCED TOPICS • Use API Keys • pass as a parameter • Rate Limiting • Headers • X-Rate-Limit-Limit - The number of allowed requests in the current period • X-Rate-Limit-Remaining - The number of remaining requests in the current period • X-Rate-Limit-Reset - The number of seconds left in the current period • Authentication • A REST API should be stateless, send auth with every request • Use ssl, send auth username and base64 password over authentication header • Caching • HTTP Provides this! • Last-Modified header • Etag header, hash or checksum, If-None-Match: “etag” • Errors • { "code" : 1234, "message" : "Something bad happened :(", "description" : "More details about the error here" } • Send HTTP Status 400 level • 401 unauthorized • 403 forbidden • 404 not found • 405 method not allowed • 410 gone (depreciated) • 422 Unprocessable entity (validation) • 429 Too many requests (Rate limit)
Editor's Notes
- Who has worked with api’s or web services before?
- If you have learned about OOP
- Who has taken networks?