Web APIs are highly variable things – they can be custom-built, designed around a single purpose, all-encompassing, and almost everything in between. Shifting requirements dictate what the interface is comprised of. Due to this, it’s hard to find commonalities between APIs and their user-facing portals. Read more
Posts Tagged: api documentation
Programming can be tough, especially when you’re starting out with a new language or trying to interact with a new API. It’s as if there are an endless number of strange procedures and functions with names you’ve never heard before, and all warranting special syntax. Read more
GraphQL is a very powerful query language that does a great many things right. When implemented properly, GraphQL offers an extremely elegant methodology for data retrieval, more backend stability, and increased query efficiency.
The key here though is that simple phrase — when implemented properly. Read more
On the one hand, having proper API documentation can be a sign of early success for an API provider, allowing new users to effectively understand the functionalities and caveats behind an API solution.
On the other hand, extensive documentation could indicate an overly complex solution with far too many variables to navigate. Read more