Recommended read: RFC6648: Deprecating the "X-" Prefix and Similar Constructs in Application Protocols https://datatracker.ietf.org/doc/html/rfc6648
Recommended read: Stop it with the X- Already! https://www.mnot.net/blog/2009/02/18/x-
Recommended read: APIs.yaml http://apisyaml.org/
Recommended read: APIs.json http://apisjson.org/
Announcing a new package:
@jamietanna/spectral-test-harness (1 mins read).
Announcing a new NPM package for easier testing of Spectral API linting.
Test Driven Development for Your Spectral Rules, using Jest (7 mins read).
How to write unit tests for Spectral API linting, in a test-driven development fashion.
Recommended read: API Handyman | Handle API gateway and backend differences in API documentation with OpenAPI Specification https://apihandyman.io/handle-api-gateway-and-backend-differences-in-api-documentation-with-openapi-specification/
Use a (JSON) Schema for the Interface Portion of your RESTful API (3 mins read).
Why you should be using a well-defined (JSON) Schema for the data classes that your API consumers will need to utilise.
Recommended read: Bring a More Inclusive Developer Strategy to APIs - The New Stack https://thenewstack.io/bring-a-more-inclusive-developer-strategy-to-apis/
Recommended read: Werner Vogel’s 6 Rules for Good API Design – The New Stack https://thenewstack.io/werner-vogels-6-rules-for-good-api-design/
Should That (Secret) Thing Be In Your Querystring? (2 mins read).
Why you should be very cautious about putting potentially sensitive values into the querystring of web APIs.
Recommended read: Considerations for event APIs (versus webhooks) — brandur.org https://brandur.org/fragments/events-api
Recommended read: Version Variants — brandur.org https://brandur.org/version-variants
Recommended read: HTTP API design: 204 "No content" mildly harmful — brandur.org https://brandur.org/fragments/http-api-204s
Recommended read: Developer Accessible APIs — brandur.org https://brandur.org/accessible-apis
Recommended read: Why Design First when Building APIs https://medium.com/graviteeio/why-design-first-when-building-apis-fc5d9cf406c4
Recommended read: The Little Manual of API Design https://www.cs.vu.nl/~jbe248/api-design.pdf
Recommended read: Anatomy of a Great API Library — brandur.org https://brandur.org/nanoglyphs/019-api-libraries
Recommended read: Adopting the OpenAPI schema to generate Plaid’s SDKs | Plaid https://plaid.com/blog/adopting-the-openapi-schema-to-generate-plaids-sdks/
Recommended read: What's the problem with required query parameters? https://apihandyman.io/what-s-the-problem-with-required-query-parameters/
You're currently viewing page 2 of 3, of 125 posts.