id
type
5
status
21
review version
0
cleanup version
0
pending deletion
0
created at
2025-05-04 10:15:57
updated at
2026-01-07 23:16:13
url
https://apisyouwonthate.com/blog/resolving-overloaded-terms-for-api-specifications-descriptions-contracts/
url length
106
url crc
59553
url crc32
2265770145
location type
1
canonical status
10
canonical page id
domain id
domain tld
0
domain parts
0
originating warc id
-
originating url
https://apisyouwonthate.com/sitemap-posts.xml
source type
1
page id
title
Resolving Overloaded Terms for API Specifications… Descriptions… Contract?
excerpt
content
Recently a bunch of us API nerds got into a big old chat about what to call what you are writing when you write OpenAPI for your API. Some people call it the API specification, others think that "specification" is a word reserved only for the markdown file in GitHub which stipulates the exact functionality of OpenAPI itself. Others call it a description document, others call it a contract, and I have definitely called it all of them from time to time. Sometimes it depends on the context. For example in the process of contract testing, the specification is definitely a contract. AGGGHH. The excellent Matthew Reinbold took a stab at this problem by writing up his model: API Specification — A technical standard, like OpenAPI 3.0, that defines how to describe an API’s interface in a general, broadly applicable way that is both a machine-parsable and human-readable. API Description — A file articulating a single API’s interface that fulfills the requireme...
author
updated
1770227342
block type
0
extracted fields
233
extracted bits
featured image
title
full content
content was extracted heuristically
OpenGraph suggests this is an article
detected location
0
detected language
1 (English)
category id
-
index version
1
paywall score
0
spam phrases
0
text nonlatin
0
text cyrillic
0
text characters
4670
text words
980
text unique words
393
text lines
1
text sentences
45
text paragraphs
1
text words per sentence
21
text matched phrases
0
text matched dictionaries
0
links self subdomains
0
links other subdomains
3
links other domains
4
links spam adult
0
links spam random
0
links spam expired
0
links ext activities
0
links ext ecommerce
0
links ext finance
0
links ext crypto
0
links ext booking
0
links ext news
0
links ext leaks
0
links ext ugc
4
links ext klim
0
links ext generic
0
image author