Phil Sturgeon - Build APIs You Won\'t Hate [2015, PDF, ENG]

Примеры страниц

скрытый текст

• Introduction
  
• Sample Code
  
• Useful Database Seeding
  • Introduction
    
  • Introduction to Database Seeding
    
  • Building Seeders
    
  • That is about it
    
  • Secondary Data
    
  • When to run this?
• Planning and Creating Endpoints
  • Functional Requirements
    
  • Endpoint Theory
    
  • Planning Endpoints
• Input and Output Theory
  • Introduction
    
  • Requests
    
  • Responses
    
  • Supporting Formats
    
  • Content Structure
• Status Codes, Errors and Messages
  • Introduction
    
  • HTTP Status Codes
    
  • Error Codes and Error Messages
    
  • Error or Errors
    
  • Standards for Error Responses
    
  • Common Pitfalls
• Endpoint Testing
  • Introduction
    
  • Concepts & Tools
    
  • Setup
    
  • Initialise
    
  • Features
    
  • Scenarios
    
  • Prepping Behat
    
  • Running Behat
• Outputting Data
  • Introduction
    
  • The Direct Approach
    
  • Transformations with Fractal
    
  • Hiding Schema Updates
    
  • Outputting Errors
    
  • Testing this Output
    
  • Homework
• Data Relationships
  • Introduction
    
  • Sub-Resources
    
  • Foreign Key Arrays
    
  • Compound Documents (a.k.a Side-Loading)
    
  • Embedded Documents (a.k.a Nesting)
    
  • Summary
• Debugging
  • Introduction
    
  • Command-line Debugging
    
  • Browser Debugging
    
  • Network Debugging
• Authentication
  • Introduction
    
  • When is Authentication Useful?
    
  • Different Approaches to Authentication
    
  • Implementing an OAuth 2.0 Server
    
  • Where the OAuth 2.0 Server Lives
    
  • Understanding OAuth 2.0 Grant Types
• Pagination
  • Introduction
    
  • Paginators
    
  • Offsets and Cursors
• Documentation
  • Introduction
    
  • Types of Documentation
    
  • Picking a Tool
    
  • Setting up API Blueprint and Aglio
    
  • Learning API Blueprint Syntax
    
  • Further Reading
• HATEOAS
  • Introduction
    
  • Content Negotiation
    
  • Hypermedia Controls
• API Versioning
  • Introduction
    
  • Different Approaches to API Versioning
    
  • Ask Your Users
• Conclusion
  
• Further Reading