Kerrick Long (code)<p>Do developers need code samples in API documentation?</p><p><a href="https://idratherbewriting.com/blog/code-samples-might-not-be-needed-anymore" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">idratherbewriting.com/blog/cod</span><span class="invisible">e-samples-might-not-be-needed-anymore</span></a></p><p><a href="https://dotnet.social/tags/APIDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>APIDocumentation</span></a> <a href="https://dotnet.social/tags/TechWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechWriting</span></a> <a href="https://dotnet.social/tags/CodeSamples" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>CodeSamples</span></a> <a href="https://dotnet.social/tags/AI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>AI</span></a> <a href="https://dotnet.social/tags/DeveloperTools" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>DeveloperTools</span></a> <a href="https://dotnet.social/tags/SoftwareDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDocumentation</span></a> <a href="https://dotnet.social/tags/APIs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>APIs</span></a> <a href="https://dotnet.social/tags/AIInTechWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>AIInTechWriting</span></a> <a href="https://dotnet.social/tags/DevDocs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>DevDocs</span></a> <a href="https://dotnet.social/tags/TechnicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TechnicalWriting</span></a> <a href="https://dotnet.social/tags/APIDocs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>APIDocs</span></a> <a href="https://dotnet.social/tags/Coding" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>Coding</span></a> <a href="https://dotnet.social/tags/AIvsManual" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>AIvsManual</span></a> <a href="https://dotnet.social/tags/SoftwareDevelopment" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDevelopment</span></a></p>
Recent searches
No recent searches
Search options
Only available when logged in.
mastodon.gamedev.place is one of the many independent Mastodon servers you can use to participate in the fediverse.
Mastodon server focused on game development and related topics.
Administered by:
Server stats:
5.3Kactive users
mastodon.gamedev.place: About · Profiles directory · Privacy policy
Mastodon: About · Get the app · Keyboard shortcuts · View source code · v4.3.7
#apidocumentation
0 posts · 0 participants · 0 posts today
Phil Sturgeon<p>💻 This was an absolute beast to write, a complete guide to OpenAPI v3.1!</p><p>Use this guide instead of the Swagger.io guide which was stuck on OpenAPI v3.0, and instead of trying to wrap your brain around the specification which isn’t intended to be user documentation. </p><p><a href="https://mastodon.green/tags/OpenAPI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>OpenAPI</span></a> <a href="https://mastodon.green/tags/APIDevelopment" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>APIDevelopment</span></a><br><a href="https://mastodon.green/tags/apidesign" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>apidesign</span></a> <a href="https://mastodon.green/tags/APIDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>APIDocumentation</span></a> <br><a href="https://docs.bump.sh/guides/openapi/specification/v3.1/introduction/what-is-openapi/" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">docs.bump.sh/guides/openapi/sp</span><span class="invisible">ecification/v3.1/introduction/what-is-openapi/</span></a></p>
:mastodon: Mike Amundsen<p>The Use of Symbology in API Documentation</p><p><a href="https://apichangelog.substack.com/p/the-use-of-symbology-in-api-documentation" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">apichangelog.substack.com/p/th</span><span class="invisible">e-use-of-symbology-in-api-documentation</span></a></p><p>"Everything is a symbol. Every symbol is a message. How can API documentation benefit from the use of symbols?" -- <a href="https://mastodon.social/tags/BrunoPedro" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>BrunoPedro</span></a></p><p><a href="https://mastodon.social/tags/api360" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>api360</span></a> <a href="https://mastodon.social/tags/apiDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>apiDocumentation</span></a> <a href="https://mastodon.social/tags/apiChangelog" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>apiChangelog</span></a></p>
:mastodon: Mike Amundsen<p>How to Document Event-Driven API Message Payloads</p><p><a href="https://apichangelog.substack.com/p/how-to-document-event-driven-api" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">apichangelog.substack.com/p/ho</span><span class="invisible">w-to-document-event-driven-api</span></a></p><p>"The REST mindset doesn't apply to event-driven design. And then you have to define the messages that subscribers will consume. What are the tools and processes that can help you?" -- <a href="https://mastodon.social/tags/BRUNO_PEDRO" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>BRUNO_PEDRO</span></a></p><p><a href="https://mastodon.social/tags/api360" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>api360</span></a> <a href="https://mastodon.social/tags/eventDriven" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>eventDriven</span></a> <a href="https://mastodon.social/tags/apiDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>apiDocumentation</span></a></p>
Phil Davis<p>AsyncAPI: Any folks with experience documenting non-RESTful APIs and other async message protocols?</p><p>Any tips or advice?</p><p>I'm having way too much fun in Redocly's beta sandbox.</p><p>I've got a bit of experience with OpenAPI/Swagger/REST so I'm mostly worried about "false friend" equivalencies and gotchas.</p><p>I'm also excited about bringing some APIs out of the Stone Age of pages of PDF tables.</p><p><a href="https://mastodon.nz/tags/apiDoc" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>apiDoc</span></a> <a href="https://mastodon.nz/tags/apiDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>apiDocumentation</span></a> <a href="https://mastodon.nz/tags/redocly" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>redocly</span></a> <a href="https://mastodon.nz/tags/technicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>technicalWriting</span></a> <a href="https://mastodon.nz/tags/documentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>documentation</span></a> <a href="https://mastodon.nz/tags/techWriterLife" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>techWriterLife</span></a> <a href="https://mastodon.nz/tags/asyncAPI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>asyncAPI</span></a></p>
Phil Sturgeon<p>🎙️🚨 API Podcast Alert! 🚨</p><p>Learn all about Redocly the handy OpenAPI documentation tool with a Swiss army CLI that does everything (even linting!), and a bit more about the plan for OpenAPI v4 (a.k.a Moonwalk). </p><p>Good natter in general with <span class="h-card" translate="no"><a href="https://indieweb.social/@lornajane" class="u-url mention" rel="nofollow noopener noreferrer" target="_blank">@<span>lornajane</span></a></span> who I always love catching up with. </p><p><a href="https://mastodon.green/tags/APIDesign" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>APIDesign</span></a><br><a href="https://mastodon.green/tags/APIDevelopment" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>APIDevelopment</span></a> <a href="https://mastodon.green/tags/apidocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>apidocumentation</span></a> </p><p><a href="https://apisyouwonthate.com/podcast/redocly-openapi-moonwalk-lorna-jane-mitchell/" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">apisyouwonthate.com/podcast/re</span><span class="invisible">docly-openapi-moonwalk-lorna-jane-mitchell/</span></a></p>
Phil Davis<p>Everyone is looking to me for API doc best practices and process. Validating, but also a little intimidating, like the teacher learning the content the night before to stay ahead of the API doc class while teaching seven other classes at the same time.</p><p>I'd appreciate y'all sharing any thoughts & references & resources, from theory to implementation.</p><p><a href="https://mastodon.nz/tags/technicalWriting" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>technicalWriting</span></a> <a href="https://mastodon.nz/tags/techWriterLife" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>techWriterLife</span></a> <a href="https://mastodon.nz/tags/writeTheDocs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>writeTheDocs</span></a> <a href="https://mastodon.nz/tags/loneWriter" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>loneWriter</span></a> <a href="https://mastodon.nz/tags/apiDoc" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>apiDoc</span></a> <a href="https://mastodon.nz/tags/apiDocs" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>apiDocs</span></a> <a href="https://mastodon.nz/tags/apiDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>apiDocumentation</span></a></p>
:mastodon: Mike Amundsen<p>Writing REST and OpenAPI documentation for a broad audience</p><p><a href="https://tedspence.com/writing-rest-and-openapi-documentation-for-a-broad-audience-72f35cbc1b89" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">tedspence.com/writing-rest-and</span><span class="invisible">-openapi-documentation-for-a-broad-audience-72f35cbc1b89</span></a></p><p>"One author’s theory of how to write usable documentation without going crazy" -- <a href="https://mastodon.social/tags/TedSpence" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>TedSpence</span></a></p><p><a href="https://mastodon.social/tags/api360" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>api360</span></a> <a href="https://mastodon.social/tags/apiDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>apiDocumentation</span></a> <a href="https://mastodon.social/tags/openAPI" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>openAPI</span></a></p>
:mastodon: Mike Amundsen<p>Tips for better documentation with OpenAPI</p><p><a href="https://lornajane.net/posts/2023/tips-for-better-documentation-with-openapi" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="ellipsis">lornajane.net/posts/2023/tips-</span><span class="invisible">for-better-documentation-with-openapi</span></a></p><p>"Between hanging out in the Write the Docs community, and recently being at the APItheDocs conference, I’ve answered a bunch of questions about getting good documentation from an OpenAPI document, so I thought I’d round them up in case it’s useful." -- <a href="https://mastodon.social/tags/LornaJane" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>LornaJane</span></a></p><p><a href="https://mastodon.social/tags/api360" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>api360</span></a> <a href="https://mastodon.social/tags/apiDocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>apiDocumentation</span></a></p>
InfoQ<p>🆕 Tesla introduced its first API documentation to support the integration of third-party applications! </p><p>Initially designed for fleet management, the real buzz is around the potential development of an app ecosystem.</p><p>Read more on <a href="https://techhub.social/tags/InfoQ" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>InfoQ</span></a>: <a href="https://bit.ly/3FFkZm8" rel="nofollow noopener noreferrer" translate="no" target="_blank"><span class="invisible">https://</span><span class="">bit.ly/3FFkZm8</span><span class="invisible"></span></a> </p><p><a href="https://techhub.social/tags/API" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>API</span></a> <a href="https://techhub.social/tags/APIdocumentation" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>APIdocumentation</span></a> <a href="https://techhub.social/tags/SoftwareDevelopment" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SoftwareDevelopment</span></a> <a href="https://techhub.social/tags/SDK" class="mention hashtag" rel="nofollow noopener noreferrer" target="_blank">#<span>SDK</span></a></p>
ExploreLive feeds
Mastodon is the best way to keep up with what's happening.
Follow anyone across the fediverse and see it all in chronological order. No algorithms, ads, or clickbait in sight.
Create accountLoginDrag & drop to upload