Petstore API Documentation

Number of APIs: 16

Techrity Mentorship Program 2022.

Technical Writing Track

Final Capstone Project

• Document the pet, user and store resources in the Petstore Swagger API.

Course Materials

• Learn APIDoc by Idratherbewriting
• Example https://hackmd.io/@missowans/rk-OsPrro documentation on hackmd
• Petstore API Docs on Qodex Final Class Recording

Mode of Submission: Techrity Github Repo, Qodex Public Link
Deadline for Submission: 13th November, 2022

Bonus points for;

• Creativity
• Adding error messages
• Proper description of endpoints
• Host via github pages or any other free docs site rendering tool like Qodex,
• Apply all the info learnt during google technical writing one, two and in technical communication mentoring sessions.

Mentors

• Funke Olasupo
• Owanate Amachree

Mentees

• Precious Velia
• Lisa Ifechi George
• Ruth Charles
• Queenesther Michael Hogan
• Joy Nwaiwu

Reach out to me or @Funke or @Owanate on Techrity Slack Community if you have questions or need more explanations.

Thank you.

1. petResource - findPetByID GET {{baseUrl}}/pet/2

2. petResource - getPetByStatus GET {{baseUrl}}/pet/findByStatus?status=pending

3. userResource - createUserWithArray POST {{baseUrl}}/user/createWithArray

4. petResource - UpdateExistingPet PUT {{baseUrl}}/pet

5. petResource - addNewPet POST {{baseUrl}}/pet

6. petResource - deletePet DELETE {{baseUrl}}/pet/2?api_key=special-key

7. petResource - uploadPetImage POST {{baseUrl}}/pet/2/uploadImage

8. storeResource - placeOrderForPet POST {{baseUrl}}/store/order

9. storeResource - findPurchaseOrderById GET {{baseUrl}}/store/order/5

10. storeResource - returnPetInventoryByStatus GET {{baseUrl}}/store/inventory