# API Academy ## Docs - [Introduction](https://academy.apidog.com/introduction-1890765m0.md): - [Table of Contents](https://academy.apidog.com/table-of-contents-1890729m0.md): - API Academy > Get Started [What is an API?](https://academy.apidog.com/what-is-an-api-1807398m0.md): - API Academy > Get Started [How Does an API Work?](https://academy.apidog.com/how-does-an-api-work-1807399m0.md): - API Academy > Get Started [How to Call an API?](https://academy.apidog.com/how-to-call-an-api-1807442m0.md): - API Academy > Get Started [How to Read an API Documentation?](https://academy.apidog.com/how-to-read-an-api-documentation-1807669m0.md): - API Academy > Get Started [Chapter Summary](https://academy.apidog.com/chapter-summary-1891052m0.md): - API Academy > API Fundamentals [API Funtamentals: Overview](https://academy.apidog.com/api-funtamentals-overview-1807764m0.md): - API Academy > API Fundamentals [What is Method & Path in an API?](https://academy.apidog.com/what-is-method-path-in-an-api-1807759m0.md): - API Academy > API Fundamentals [What are Parameters in an API?](https://academy.apidog.com/what-are-parameters-in-an-api-1807760m0.md): - API Academy > API Fundamentals [What is a Request Body in an API?](https://academy.apidog.com/what-is-a-request-body-in-an-api-1807844m0.md): - API Academy > API Fundamentals [What are Responses in an API?](https://academy.apidog.com/what-are-responses-in-an-api-1807849m0.md): - API Academy > API Fundamentals [What is an API Specification? What is OAS(OpenAPI Specification)?](https://academy.apidog.com/what-is-an-api-specification-what-is-oasopenapi-specification-1808127m0.md): - API Academy > API Fundamentals [Chapter Summary](https://academy.apidog.com/chapter-summary-1879616m0.md): - API Academy > Working with APIs [Working with APIs: Overview](https://academy.apidog.com/working-with-apis-overview-1879522m0.md): - API Academy > Working with APIs [Making Requests from Spec](https://academy.apidog.com/making-requests-from-spec-1808301m0.md): - API Academy > Working with APIs [Environments and Variables](https://academy.apidog.com/environments-and-variables-1878945m0.md): - API Academy > Working with APIs [Chaining Multiple Endpoints](https://academy.apidog.com/chaining-multiple-endpoints-1878952m0.md): - API Academy > Working with APIs [Handling Authentication](https://academy.apidog.com/handling-authentication-1879037m0.md): - API Academy > Working with APIs [Handling API Signatures](https://academy.apidog.com/handling-api-signatures-1879042m0.md): - API Academy > Working with APIs [Introduction to Scripts](https://academy.apidog.com/introduction-to-scripts-1879057m0.md): - API Academy > Working with APIs [Chapter Summary](https://academy.apidog.com/chapter-summary-1879323m0.md): - API Academy > Mocking APIs [Mocking APIs: Overview](https://academy.apidog.com/mocking-apis-overview-1880402m0.md): - API Academy > Mocking APIs [Smart Mock](https://academy.apidog.com/smart-mock-1880403m0.md): - API Academy > Mocking APIs [Mock Expectations](https://academy.apidog.com/mock-expectations-1880409m0.md): - API Academy > Mocking APIs [Cloud Mock](https://academy.apidog.com/cloud-mock-1880410m0.md): - API Academy > Mocking APIs [Mock Scripts](https://academy.apidog.com/mock-scripts-1880586m0.md): - API Academy > Mocking APIs [Chapter Summary](https://academy.apidog.com/chapter-summary-1880590m0.md): - API Academy > Designing APIs [Designing APIs: Overview](https://academy.apidog.com/designing-apis-overview-1883372m0.md): - API Academy > Designing APIs [Introduction to API Design](https://academy.apidog.com/introduction-to-api-design-1883330m0.md): - API Academy > Designing APIs [Creating Your First API Project](https://academy.apidog.com/creating-your-first-api-project-1885794m0.md): - API Academy > Designing APIs [Analyzing Requirements and Planning Your API](https://academy.apidog.com/analyzing-requirements-and-planning-your-api-1883344m0.md): - API Academy > Designing APIs [Designing Data Models](https://academy.apidog.com/designing-data-models-1883373m0.md): - API Academy > Designing APIs [Designing Endpoints](https://academy.apidog.com/designing-endpoints-1885814m0.md): - API Academy > Designing APIs [Using Components and Reusability](https://academy.apidog.com/using-components-and-reusability-1885831m0.md): - API Academy > Designing APIs [Setting Up Authentication](https://academy.apidog.com/setting-up-authentication-1885850m0.md): - API Academy > Designing APIs [API Design Guidelines](https://academy.apidog.com/api-design-guidelines-1885884m0.md): - API Academy > Designing APIs [Chapter Summary](https://academy.apidog.com/chapter-summary-1885888m0.md): - API Academy > Developing APIs [Developing APIs: Overview](https://academy.apidog.com/developing-apis-overview-1885975m0.md): - API Academy > Developing APIs [Setup: Install Your AI Coding Assistant](https://academy.apidog.com/setup-install-your-ai-coding-assistant-1886980m0.md): - API Academy > Developing APIs [Quick Start: From Spec to Running API in 30 Minutes](https://academy.apidog.com/quick-start-from-spec-to-running-api-in-30-minutes-1886982m0.md): - API Academy > Developing APIs [Understanding the Generated Code](https://academy.apidog.com/understanding-the-generated-code-1886986m0.md): - API Academy > Developing APIs [Testing Your API with Apidog](https://academy.apidog.com/testing-your-api-with-apidog-1886987m0.md): - API Academy > Developing APIs [Deployment: Put Your API Online](https://academy.apidog.com/deployment-put-your-api-online-1887002m0.md): - API Academy > Developing APIs [Chapter Summary](https://academy.apidog.com/chapter-summary-1887059m0.md): - API Academy > Testing APIs [Testing APIs: Overview](https://academy.apidog.com/testing-apis-overview-1887069m0.md): - API Academy > Testing APIs [Getting Started: Your First Test Scenario](https://academy.apidog.com/getting-started-your-first-test-scenario-1887080m0.md): - API Academy > Testing APIs [Integration Testing and Data Passing](https://academy.apidog.com/integration-testing-and-data-passing-1889527m0.md): - API Academy > Testing APIs [Dynamic Values](https://academy.apidog.com/dynamic-values-1890688m0.md): - API Academy > Testing APIs [Assertions and Validations](https://academy.apidog.com/assertions-and-validations-1889549m0.md): - API Academy > Testing APIs [Flow Control: If, For, ForEach](https://academy.apidog.com/flow-control-if-for-foreach-1889959m0.md): - API Academy > Testing APIs [Data-Driven Testing](https://academy.apidog.com/data-driven-testing-1889962m0.md): - API Academy > Testing APIs [Performance Testing](https://academy.apidog.com/performance-testing-1889579m0.md): - API Academy > Testing APIs [Test Reports and Analysis](https://academy.apidog.com/test-reports-and-analysis-1889963m0.md): - API Academy > Testing APIs [CI/CD Integration](https://academy.apidog.com/cicd-integration-1889967m0.md): - API Academy > Testing APIs [Scheduled Tasks and Automation](https://academy.apidog.com/scheduled-tasks-and-automation-1889968m0.md): - API Academy > Testing APIs [Advanced Testing Strategies](https://academy.apidog.com/advanced-testing-strategies-1889969m0.md): - API Academy > Testing APIs [Chapter Summary](https://academy.apidog.com/chapter-summary-1889970m0.md): - API Academy > API Documentations [API Documentations: Overview](https://academy.apidog.com/api-documentations-overview-1890667m0.md): - API Academy > API Documentations [Publishing Your First API Doc](https://academy.apidog.com/publishing-your-first-api-doc-1890668m0.md): - API Academy > API Documentations [Customizing Documentation Appearance](https://academy.apidog.com/customizing-documentation-appearance-1890669m0.md): - API Academy > API Documentations [Interactive Features for Consumers](https://academy.apidog.com/interactive-features-for-consumers-1890670m0.md): - API Academy > API Documentations [Advanced Publishing Settings](https://academy.apidog.com/advanced-publishing-settings-1890671m0.md): - API Academy > API Documentations [Managing API Versions](https://academy.apidog.com/managing-api-versions-1890672m0.md): - API Academy > API Documentations [Chapter Summary](https://academy.apidog.com/chapter-summary-1890675m0.md): - API Academy > Advanced API Technologies [API Technologies: Overview](https://academy.apidog.com/api-technologies-overview-1890676m0.md): - API Academy > Advanced API Technologies [GraphQL](https://academy.apidog.com/graphql-1890677m0.md): - API Academy > Advanced API Technologies [gRPC](https://academy.apidog.com/grpc-1890678m0.md): - API Academy > Advanced API Technologies [WebSocket](https://academy.apidog.com/websocket-1890679m0.md): - API Academy > Advanced API Technologies [Socket.IO](https://academy.apidog.com/socket-io-1890680m0.md): - API Academy > Advanced API Technologies [Server-Sent Events (SSE)](https://academy.apidog.com/server-sent-events-sse-1890681m0.md): - API Academy > Advanced API Technologies [SOAP](https://academy.apidog.com/soap-1890682m0.md): - API Academy > Advanced API Technologies [Chapter Summary](https://academy.apidog.com/chapter-summary-1890683m0.md): - API Academy > API Lifecycle [API Lifecycle: Overview](https://academy.apidog.com/api-lifecycle-overview-1890804m0.md): - API Academy > API Lifecycle [Stages of the API Lifecycle](https://academy.apidog.com/stages-of-the-api-lifecycle-1890805m0.md): - API Academy > API Lifecycle [API Governance](https://academy.apidog.com/api-governance-1890806m0.md): - API Academy > API Lifecycle [API Security Best Practices](https://academy.apidog.com/api-security-best-practices-1890807m0.md): - API Academy > API Lifecycle [Monitoring and Analytics](https://academy.apidog.com/monitoring-and-analytics-1890808m0.md): - API Academy > API Lifecycle [API Versioning Strategies](https://academy.apidog.com/api-versioning-strategies-1890809m0.md): - API Academy > API Lifecycle [The Future of APIs](https://academy.apidog.com/the-future-of-apis-1890810m0.md): - API Academy > API Lifecycle [Chapter Summary](https://academy.apidog.com/chapter-summary-1890811m0.md): - API Academy > API Security [API Security: Overview](https://academy.apidog.com/api-security-overview-1891494m0.md): - API Academy > API Security [API Security Fundamentals](https://academy.apidog.com/api-security-fundamentals-1891496m0.md): - API Academy > API Security [Authentication vs Authorization](https://academy.apidog.com/authentication-vs-authorization-1891500m0.md): - API Academy > API Security [Understanding OAuth 2.0 and OpenID Connect](https://academy.apidog.com/understanding-oauth-2-0-and-openid-connect-1891495m0.md): - API Academy > API Security [JSON Web Tokens (JWT)](https://academy.apidog.com/json-web-tokens-jwt-1891499m0.md): - API Academy > API Security [OWASP API Security Top 10](https://academy.apidog.com/owasp-api-security-top-10-1891501m0.md): - API Academy > API Security [Encryption and HTTPS](https://academy.apidog.com/encryption-and-https-1891498m0.md): - API Academy > API Security [Chapter Summary](https://academy.apidog.com/chapter-summary-1891497m0.md): - API Academy > API Tools [API Tools: Overview](https://academy.apidog.com/api-tools-overview-1891503m0.md): - API Academy > API Tools [The Evolution of API Tools](https://academy.apidog.com/the-evolution-of-api-tools-1891509m0.md): - API Academy > API Tools [API Clients](https://academy.apidog.com/api-clients-1891502m0.md): - API Academy > API Tools [Command Line Tools (cURL, HTTPie)](https://academy.apidog.com/command-line-tools-curl-httpie-1891510m0.md): - API Academy > API Tools [API Design and Documentation Tools](https://academy.apidog.com/api-design-and-documentation-tools-1891504m0.md): - API Academy > API Tools [API Mocking Tools](https://academy.apidog.com/api-mocking-tools-1891505m0.md): - API Academy > API Tools [API Testing Tools](https://academy.apidog.com/api-testing-tools-1891506m0.md): - API Academy > API Tools [All-in-One API Platforms](https://academy.apidog.com/all-in-one-api-platforms-1891508m0.md): - API Academy > API Tools [Chapter Summary](https://academy.apidog.com/chapter-summary-1891507m0.md): - API Academy > API Gateway [API Gateway: Overview](https://academy.apidog.com/api-gateway-overview-1891532m0.md): - API Academy > API Gateway [What is an API Gateway?](https://academy.apidog.com/what-is-an-api-gateway-1891535m0.md): - API Academy > API Gateway [Key Features of API Gateways](https://academy.apidog.com/key-features-of-api-gateways-1891536m0.md): - API Academy > API Gateway [API Gateway vs Load Balancer vs Service Mesh](https://academy.apidog.com/api-gateway-vs-load-balancer-vs-service-mesh-1891537m0.md): - API Academy > API Gateway [Popular API Gateway Solutions](https://academy.apidog.com/popular-api-gateway-solutions-1891534m0.md): - API Academy > API Gateway [The BFF (Backend for Frontend) Pattern](https://academy.apidog.com/the-bff-backend-for-frontend-pattern-1891531m0.md): - API Academy > API Gateway [Chapter Summary](https://academy.apidog.com/chapter-summary-1891533m0.md): ## API Docs - API Academy > Get Started [Get realtime weather](https://academy.apidog.com/get-realtime-weather-24838732e0.md): Realtime weather API method allows a user to get up to date current weather information in json. - Modern Pet Store > Pet [Get Pet](https://academy.apidog.com/get-pet-24858802e0.md): Retrieve detailed information about a specific pet. - Modern Pet Store > Pet [Update Pet](https://academy.apidog.com/update-pet-24858803e0.md): Update information for an existing pet. Staff only. - Modern Pet Store > Pet [Delete Pet](https://academy.apidog.com/delete-pet-24858804e0.md): Delete a pet from the system. Staff only. - Modern Pet Store > Pet [Create Pet](https://academy.apidog.com/create-pet-24858805e0.md): Add a new pet to the store catalog, making it available for adoption. - Modern Pet Store > Pet [List Pets](https://academy.apidog.com/list-pets-24858806e0.md): Retrieve a paginated list of pets available for adoption with optional filtering. - Modern Pet Store > Pet [Upload Pet Image](https://academy.apidog.com/upload-pet-image-25809608e0.md): Upload an image for the specified pet. Requires authentication and write:pets permission. - Modern Pet Store > User [Update User](https://academy.apidog.com/update-user-25809611e0.md): Update user information. Only the logged-in user can perform this operation. - Modern Pet Store > User [Get User](https://academy.apidog.com/get-user-25809612e0.md): Retrieve user information by user ID. - Modern Pet Store > User [Delete User](https://academy.apidog.com/delete-user-25809613e0.md): Delete a user account. Only the logged-in user can perform this operation. - Modern Pet Store > User [Login](https://academy.apidog.com/login-25809614e0.md): User logs in and generates a session. Submit credentials in the request body for secure authentication. - Modern Pet Store > User [Logout](https://academy.apidog.com/logout-25809615e0.md): Log out the current logged-in user and invalidate their session token. - Modern Pet Store > User [Create User](https://academy.apidog.com/create-user-24895609e0.md): Create a new user in the system. - Modern Pet Store > Store [List Inventory](https://academy.apidog.com/list-inventory-24895604e0.md): Returns a mapping of status codes to quantities. - Modern Pet Store > Store [Create Order](https://academy.apidog.com/create-order-24895605e0.md): Create a new order in the store. - Modern Pet Store > Store [Get Order](https://academy.apidog.com/get-order-24895606e0.md): For a valid response, try integer IDs in the range 1-10. Other values will generate exceptions. - Modern Pet Store > Store [Delete Order](https://academy.apidog.com/delete-order-24895607e0.md): For a valid response, try positive integer order IDs. Negative or non-integer values will cause an API error. - Modern Pet Store > Store [Callback Example](https://academy.apidog.com/callback-example-24895608e0.md): Handles order events and supports asynchronous processing with Callback. - Modern Pet Store > Store [Pay for an Order](https://academy.apidog.com/pay-for-an-order-24895603e0.md): A payment is an attempt to pay for the order, which will confirm it for the user and enable them to get their tickets. - Modern Pet Store > Payments [Pay Order](https://academy.apidog.com/pay-order-25809610e0.md): Process payment for an existing order. - Modern Pet Store > Chat [Create Chat Completion](https://academy.apidog.com/create-chat-completion-25809609e0.md): Creates a model response for a chat conversation with the Pet Adoption Advisor AI. Supports streaming responses using Server-Sent Events (SSE). - Modern Pet Store > Webhooks [Pet Adopted Event](https://academy.apidog.com/pet-adopted-event-25809616e0.md): Triggered when a pet is successfully adopted. The webhook will be sent to the URL configured in your account settings. - Modern Pet Store > Webhooks [New Pet Available Event](https://academy.apidog.com/new-pet-available-event-25809617e0.md): Triggered when a new pet becomes available for adoption. ## Schemas - [Pet](https://academy.apidog.com/pet-11258720d0.md): - [Category](https://academy.apidog.com/category-11258721d0.md): - [User](https://academy.apidog.com/user-11276205d0.md): - [ApiResponse](https://academy.apidog.com/apiresponse-11258722d0.md): - [OrderPayment](https://academy.apidog.com/orderpayment-11276206d0.md): - [Tag](https://academy.apidog.com/tag-11258723d0.md): - [Order](https://academy.apidog.com/order-11276208d0.md): - [Links-Order](https://academy.apidog.com/links-order-11276207d0.md): - [PetCollection](https://academy.apidog.com/petcollection-11756663d0.md): - [CardPaymentSource](https://academy.apidog.com/bank-card-11756664d0.md): - [BankAccountPaymentSource](https://academy.apidog.com/bank-account-11756665d0.md): - [Links](https://academy.apidog.com/links-11756666d0.md): - [Error](https://academy.apidog.com/error-11756667d0.md):