Treblletrebllemakers.hashnode.dev·Apr 11, 2024How does Treblle API Documentation Hold Up to Phil’s Snooty StandardsCreating API Documentation is never a quick job. Despite decades of constantly trying to improve the scene, it can still take a huge amount of time to get something built from scratch. If you're following the API Design-first workflow, then you're pr...DiscussAPIs
Venkat Rvenkatr.hashnode.dev·Apr 1, 2024Writing Effective API Documentation: A Guide with ExamplesAPI documentation is essentially a guidebook that explains how to interact with an application programming interface (API). It's like an instruction manual for developers, allowing them to understand what the API offers, how to use its functions, and...Discuss·36 readsAPIs
Ragavi S PforDocument360document360.hashnode.dev·Feb 29, 20247 challenges in technical writing and how to overcome themTechnical writers are required to work on several different types of documentation, ranging from user manuals, instructional guides, standard operating procedures, employee handbooks, and more. No two days are the same and the work is usually engagin...DiscussTechnical writing
Sahil Rajputsahilrajput.hashnode.dev·Feb 17, 2024Documenting a Spring REST API Using OpenAPI and Swagger-UIHello World !! In my previous blogs, we have seen how to develop REST CRUD APIs using Spring Boot and MongoDB. Spring Boot + MongoDB : Pagination APIs - Click Link In this blog, we have created some APIs to get data from database using pagination. ...Discuss·33 readsSpringboot
Preston MayiekaforWrite the Docs Kenyawtdkenya.hashnode.dev·Jan 29, 2024Writing Comprehensive API DocumentationAPI stands for Application Programming Interface.An API (Application Programming Interface) simply allows two or more computer programs or systems to interact. On the other hand, we have API documentation. This is a written guide meant to explain th...Discuss·11 likes·90 readstechnica
Inioluwa Adeyemoinioluwa2003.hashnode.dev·Jan 27, 2024API Documentation: Crafting Clear and User-Friendly Guides for DevelopersAPI Documentation is a set of guidelines that developers use to understand how to interact with an API's software library, framework, or service. It provides information on the functionalities, methods, parameters, and data formats supported by the A...Discuss·10 likesConnecting the Dots: API and Webhook Chronicles2Articles1Week
Jeremiah Igramijegrami.hashnode.dev·Jan 8, 2024REST API for technical writers: a primerREST APIs are a type of API that involves a user making data requests to servers and servers responding with the requested information, as long as the user (called client) follows the standard protocol. HTTP is the protocol used for this data exchang...DiscussREST API
Jeremiah Igramijegrami.hashnode.dev·Dec 20, 2023Common Types of APIs Technical Writers Should KnowAPI stands for application programming interface. They’re a way for digital systems to interact with each other and exchange information over the internet. APIs differ from user interfaces (UIs). While the user interface allows communication between ...Discuss·1 likeAPIs
Rory Murphyapidna.hashnode.dev·Dec 1, 2023API Documentation: Best Practices for BeginnersWe’ve all been there: struggling with an API because its documentation is confusing or incomplete. It’s a frustrating experience that often leads us to abandon the API in search of a better-documented alternative. So, when it’s your turn to write an ...DiscussWeb Development
Patrick Arikpostormtrooper1.hashnode.dev·Oct 12, 2023Writing API Documentation that Complies with Industry StandardsIntroduction This article is intended for developers aiming to grasp the most important elements of writing API documentation that comply with industry standards. Ever wondered how API documentation impacts the productivity of developers? Let’s delve...Discuss·50 readsAPIs