- Introduction
- Sample Code
-
1. Useful Database Seeding
- 1.1 Introduction
- 1.2 Introduction to Database Seeding
- 1.3 Building Seeders
- 1.4 That is about it
- 1.5 Secondary Data
- 1.6 When to run this?
-
2. Planning and Creating Endpoints
- 2.1 Functional Requirements
- 2.2 Endpoint Theory
- 2.3 Planning Endpoints
-
3. Input and Output Theory
- 3.1 Introduction
- 3.2 Requests
- 3.3 Responses
- 3.4 Supporting Formats
- 3.5 Content Structure
-
4. Status Codes, Errors and Messages
- 4.1 Introduction
- 4.2 HTTP Status Codes
- 4.3 Error Codes and Error Messages
- 4.4 Error or Errors
- 4.5 Standards for Error Responses
- 4.6 Common Pitfalls
-
5. Endpoint Testing
- 5.1 Introduction
- 5.2 Concepts & Tools
- 5.3 Setup
- 5.4 Initialise
- 5.5 Features
- 5.6 Scenarios
- 5.7 Prepping Behat
- 5.8 Running Behat
-
6. Outputting Data
- 6.1 Introduction
- 6.2 The Direct Approach
- 6.3 Transformations with Fractal
- 6.4 Hiding Schema Updates
- 6.5 Outputting Errors
- 6.6 Testing this Output
- 6.7 Homework
-
7. Data Relationships
- 7.1 Introduction
- 7.2 Subresources
- 7.3 Foreign Key Arrays
- 7.4 Compound Documents (aka Sideloading)
- 7.5 Embedded Documents (aka Nesting)
- 7.6 Summary
-
8. Debugging
- 8.1 Introduction
- 8.2 Command-line Debugging
- 8.3 Browser Debugging
- 8.4 Network Debugging
-
9. Authentication
- 9.1 Introduction
- 9.2 When is Authentication Useful?
- 9.3 Different Approaches to Authentication
- 9.4 Implementing an OAuth 2.0 Server
- 9.5 Where the OAuth 2.0 Server Lives
- 9.6 Understanding OAuth 2.0 Grant Types
-
10. Pagination
- 10.1 Introduction
- 10.2 Paginators
- 10.3 Offsets and Cursors
-
11. Documentation
- 11.1 Introduction
- 11.2 Types of Documentation
- 11.3 Picking a Tool
- 11.4 Setting up API Blueprint and Aglio
- 11.5 Learning API Blueprint Syntax
- 11.6 Further Reading
-
12. HATEOAS
- 12.1 Introduction
- 12.2 Content Negotiation
- 12.3 Hypermedia Controls
-
13. API Versioning
- 13.1 Introduction
- 13.2 Different Approaches to API Versioning
- 13.3 Ask Your Users
-
14. Bonus Chapter: File Uploads & Downloads
- 14.1 Introduction
- 14.2 Downloads
- 14.3 Uploads
- 14.4 Why Multipart is Fairly Awful
- 14.5 Method A: Direct File Upload
- 14.6 Method B: Upload from URL
- 14.7 What about Meta Data?
- 14.8 Summary
- Conclusion
-
Further Reading
- API Web Resources
- Non-API Books
Build APIs You Won't Hate
Everyone and their dog wants an API, so you should probably learn how to build them.
Tasked with building an API for your company but don't have a clue where to start? Taken over an existing API and hate it? Built your own API and still hate it? This book is for you.
The author is letting you choose the price you pay for this book!
Tasked with building an API for your company but don't have a clue where to start? Taken over an existing API and hate it? Built your own API and still hate it? This book is for you.
PDF
EPUB
WEB
4,474
Readers
190
Pages
38,396Words
About
About the Book
API development is becoming increasingly common for server-side developers thanks to the rise of front-end JavaScript frameworks, iPhone applications, and API-centric architectures. It might seem like grabbing stuff from a data source and shoving it out as JSON would be easy, but surviving changes in business logic, database schema updates, new features, or deprecated endpoints can be a nightmare.
After finding many of the existing resources for API development to be lacking, Phil learned a lot of things the hard way through years of trial and error. This book aims to condense that experience, taking examples and explanations further than the trivial apples and pears nonsense tutorials often provide.
Phil worked primarily as an API developer for the last three years. One horror was managing an API built in FuelPHP by a freelancer at the million dollar startup he joined. It was utilizing a then deprecated ORM which had been hacked to death by the previous developer, so took the time to delete that mess and build the next version in Laravel, leveraging it's simple routing, database migrations, schema, seeding, etc. When the following major version of the API was built no rewrite was required, and both managed to live side-by-side on the same "API" servers.
By passing on some best practices and general good advice you can hit the ground running with API development, combined with some horror stories and how they were overcome/avoided/averted. This book will discuss the theory of designing and building APIs in any language or framework, with this theory applied in PHP-based examples.
Some of the more advanced topics covered here are endpoint testing, embedding data objects in a consistent and scalable manner, paginating responses (including embedded objects) and hypermedia "HATEOAS" controls.
Price
Pick Your Price...
Minimum price
$26.99
$29.99
You pay
$29.99Author earns
$21.59Cause gets
$2.40Author
About the Author
Phil Sturgeon
Since 2010 I've worked as a freelancer, consultant, API lead, and CTO for several API-centric technology startups. Working as an internal API consultant for WeWork gave me a lot to write about, where I used my experience of things going horribly horribly wrong to help educate developers, define standards for API design and architecture, and implementing full API design lifecycles so we weren't all just building nonsense and hoping it was useful.
Trying to get loads of different questionably built APIs tidied up, playing nicely, and working quickly was a constant source of learning for me and everyone involved. I took a lot of that learning to Stoplight, and helped plan, build, and manage most of your favourite OpenAPI tools.
When I'm not banging on about APIs I'm riding, racing, or crashing various bikes, or saving the plant through Protect Earth, an environmental charity I co-founded in 2020. We create brand new woodlands, restore and extend ancient woodlands, and run around with machetes getting rid of invasive species.
Episode 292
An Interview with Phil Sturgeon
Translations
Translations
Languages
Translation Bundles
Laravel Avançado & APIs
2 Books
Bought separately
$58.98
Minimum price
$28.99
Suggested price
$28.99
Build APIs (Italian + English Bundle)
2 Books
Bought separately
$58.98
Minimum price
$32.99
Suggested price
$32.99
Contents
Table of Contents
Contributors
About the Contributors
Alex Biblie
Alex knows his stuff about APIs. Previously working at the University of Lincoln he used to build out OAuth-based APIs for them. Then he moved to @VideoGamerCom and is doing the same for them, at a very high level.
Alex also created the OAuth 2 PHP Server used in the later chapters, so is the perfect person to help out with technical review.
Get the free sample chapters
Click the buttons to get the free sample in PDF or EPUB, or read the sample online here
Causes
Causes Supported
Protect Earth
https://protect.earthWe plant trees, wildflowers, and remove invasives to tackle the climate/biodiversity crises, and literally everyone can get involved! Registered charity 1192453
Protect Earth create, restores, and protects woodlands all over the UK. We plant tens of thousands of trees every year on low quality farmland, schools, wedding venues, council land, road verges, golf courses, or anywhere else that makes sense. Increasingly Protect Earth is securing its own land, restoring an ancient temporate rainforest in Cornwall, and creating a brand new temperate rainforest in Wales.
The Leanpub 60 Day 100% Happiness Guarantee
Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
Now, this is technically risky for us, since you'll have the book or course files either way. But we're so confident in our products and services, and in our authors and readers, that we're happy to offer a full money back guarantee for everything we sell.
You can only find out how good something is by trying it, and because of our 100% money back guarantee there's literally no risk to do so!
So, there's no reason not to click the Add to Cart button, is there?
See full terms...
Earn $8 on a $10 Purchase, and $16 on a $20 Purchase
We pay 80% royalties on purchases of $7.99 or more, and 80% royalties minus a 50 cent flat fee on purchases between $0.99 and $7.98. You earn $8 on a $10 sale, and $16 on a $20 sale. So, if we sell 5000 non-refunded copies of your book for $20, you'll earn $80,000.
(Yes, some authors have already earned much more than that on Leanpub.)
In fact, authors have earned over $14 million writing, publishing and selling on Leanpub.
Learn more about writing on Leanpub
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers) and EPUB (for phones, tablets and Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Learn more about Leanpub's ebook formats and where to read them
Write and Publish on Leanpub
You can use Leanpub to easily write, publish and sell in-progress and completed ebooks and online courses!
Leanpub is a powerful platform for serious authors, combining a simple, elegant writing and publishing workflow with a store focused on selling in-progress ebooks.
Leanpub is a magical typewriter for authors: just write in plain text, and to publish your ebook, just click a button. (Or, if you are producing your ebook your own way, you can even upload your own PDF and/or EPUB files and then publish with one click!) It really is that easy.