OpenAPI Blog Guidelines
The OpenAPI blog serves as a channel for the members and the community at large to broadcast to a wide audience how your work and engagement is growing opportunities for the OpenAPI Initiative and the OAS (OpenAPI Specification). Accepted blog posts are at the sole discretion of the OpenAPI Initiative.
This may include summaries of how leading institutions, companies and developers are using, developing and advancing APIs. We are looking for stories of both success and failure, attempts and completions, from companies and devs of all sizes and shapes.
We publish technical and non-technical content. Those involved with developing, maintaining, distributing, and using APIs are encouraged to contribute to the blog. Product managers, business development managers, and writers of all types are all welcome.
We’re looking for guest bloggers from the API community who want to share their work and learnings. Recognizing that we all learn from each other’s stories, we want to build a portfolio of those stories that can help the broader API community.
Feel free to write about API-related conferences (including ASC 2021), meetings, local user groups worldwide, new working groups or programs for API certification and training. Likewise, we’d love to hear about how you have implemented (or tried to implement) API standards in your company, helped define API strategies, worked with partners on API integrations, and any other tales from the edge.
Quality, Attribution and License
We are looking for posts that teach and give value to our community. Blogs should recognize the immense value of standardizing on how APIs are described and how the OpenAPI Initiative supports the worldwide community of users, maintainers and developers of APIs.
Guest posts must be vendor neutral, though they may mention vendors involved in specific deployment or adoption paths, or their hosting of an in-person event or speaking at an event, or other indications of meaningful participation in the community. It shouldn’t feel like an advertisement for your product, services or company though.
Your post must be your content, but can be published elsewhere on the Internet with permission from that website. All content should have a byline and be published under Creative Commons with Attribution. You’re welcome to re-publish on your own blog.
The most interesting posts are those that teach or show how to do something in a way maybe others haven’t thought of. Good blog posts show hurdles that were encountered and explain how they were overcome (not that everything is rainbows and unicorns). When showing a solution to an issue for others, link back to the Github issue, so readers can follow along.
Be interesting and inspiring!
Code of Conduct
We don’t avoid critical commentary or broad issues, but approach them with sensitivity, professionalism and tact in a way that is beneficial and positive for the community. Under our Code of Conduct, we pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. If you want more information about our Code of Conduct, it can be found here.
Your blog will be shared on OpenAPI’s Twitter channels (@openapispec and @apispecs) and LinkedIn. Please feel free to retweet or share. Don’t forget to share your work on your own social channels and favorite news aggregator sites. Suggested sites: Twitter, LinkedIn, Reddit, Hacker News, DZone, TechBeacon, CodeProject.
How to submit for consideration
Please submit the blog post or a brief summary and the topic of the post to email@example.com with the Subject line: “Proposed Blog: BLOG TITLE” for consideration. The PR team will review your submission in a timely manner and provide the green light to draft the entire article or provide feedback on next steps.
If you are submitting an article or presentation that already exists, please send it in its entirety with a note on the expressed permission from the owner of content.
Once your submission has been approved, it will be added to our blog publishing calendar and a publish date will be provided, so you may plan to promote accordingly through your personal and company social media channels.
Blog posts should generally be no longer than 1,000 words and no shorter than 300 words. Diagrams, code examples or photos are strongly encouraged.