Swagger API Documentation Developer

5centsCDN•Remote, Oregon, United States, OR

13d

About The Position

We are looking for a motivated Swagger API Documentation Developer to elevate the API Management Team's services. This role involves API testing, creating and maintaining product documentation for in-house API building websites, and other related tasks. The ideal candidate will work closely with the team, demonstrate proficiency in YAML, and take ownership of API testing processes including inspecting web browsers for request payloads, adding them to Swagger API documentation, testing APIs using Postman, and creating Postman collections. Additionally, the role requires writing and editing technical product documentation for in-house APIs, collaborating with internal development and engineering teams, learning and understanding product functions and limitations, adapting content for various audiences and channels, and improving existing technical API documentation.

Requirements

Experience as a Backend Developer: Proficient in Restful APIs and PHP.
Excellent written skills in English.
Experience in writing technical documents is a must.
Excited about our product and to learn more about the tech and CDN industry.
Interest in cloud-based technology solutions.
Know how to break down complex topics into easily understandable information.
A doer with a can-do, figure it out type of energy, willing to jump in and help.

Responsibilities

Proven background and vast experience in Swagger documentation.
Work closely with the team and demonstrate knowledge in YAML format.
Take ownership of testing the API: Inspect the web browser and get the required request payload and add it to the Swagger API Documentation.
Test the API using Postman.
Create a Postman collection.
Writing and editing technical product documentation for in-house APIs.
Collaborating with our internal teams of developers and engineers.
Learn and demonstrate an understanding of product functions and limitations.
Adapting content to suit different audiences and channels.
Improving and updating existing technical API documentation.