api description to developer portal: translating and testing your documentation
TRANSCRIPT
![Page 1: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/1.jpg)
© Avalara
Translating and Testing your documentation
From API Description to Developer Site
Anya StettlerDefrag 2015
![Page 2: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/2.jpg)
Making sales tax less taxing 2CONFIDENTIAL & PROPRIETARY |
![Page 3: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/3.jpg)
Making sales tax less taxing 3CONFIDENTIAL & PROPRIETARY |
![Page 4: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/4.jpg)
Making sales tax less taxing 4CONFIDENTIAL & PROPRIETARY |
https://stripe.com/docs/api#charges
![Page 5: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/5.jpg)
Making sales tax less taxing 5CONFIDENTIAL & PROPRIETARY |
Policy AND Technology
![Page 6: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/6.jpg)
Making sales tax less taxing 6CONFIDENTIAL & PROPRIETARY |
![Page 7: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/7.jpg)
Making sales tax less taxing 7CONFIDENTIAL & PROPRIETARY |
…/v2/users
Vs
…/2.0/users
Consistency is key
![Page 8: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/8.jpg)
Making sales tax less taxing 8CONFIDENTIAL & PROPRIETARY |
Not everything is worth fighting about
![Page 9: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/9.jpg)
Making sales tax less taxing 9CONFIDENTIAL & PROPRIETARY |
Central dictionary for shared vocabulary
We all need to speak the same langauge
![Page 10: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/10.jpg)
Making sales tax less taxing 10CONFIDENTIAL & PROPRIETARY |
Rules can’t stand alone
![Page 11: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/11.jpg)
Making sales tax less taxing 11CONFIDENTIAL & PROPRIETARY |
More tools, less governance!
![Page 12: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/12.jpg)
Making sales tax less taxing 12CONFIDENTIAL & PROPRIETARY |
The right way should be easy
![Page 13: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/13.jpg)
Making sales tax less taxing 13CONFIDENTIAL & PROPRIETARY |
draft standards
draft standards
... in committee
create tools
management
management
management
Nag nag nag...
tool maintenance
time saved through
automation
![Page 14: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/14.jpg)
Making sales tax less taxing 14CONFIDENTIAL & PROPRIETARY |
https://github.com/paypal/api-standards/blob/master/api-style-guide.md
![Page 15: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/15.jpg)
Making sales tax less taxing 15CONFIDENTIAL & PROPRIETARY |
Franchise!
-‐ Value input
-‐ Pilot program
-‐ Transparent feedback
![Page 16: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/16.jpg)
Making sales tax less taxing 16CONFIDENTIAL & PROPRIETARY |
Guide lines road
![Page 17: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/17.jpg)
Making sales tax less taxing 17CONFIDENTIAL & PROPRIETARY |
![Page 18: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/18.jpg)
Making sales tax less taxing 18CONFIDENTIAL & PROPRIETARY |
http://swagger.io/
![Page 19: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/19.jpg)
Making sales tax less taxing 19CONFIDENTIAL & PROPRIETARY |
?
![Page 20: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/20.jpg)
Making sales tax less taxing 20CONFIDENTIAL & PROPRIETARY |
Is it valid Swagger?
![Page 21: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/21.jpg)
Making sales tax less taxing 21CONFIDENTIAL & PROPRIETARY |
Vendor headers
![Page 22: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/22.jpg)
Making sales tax less taxing 22CONFIDENTIAL & PROPRIETARY |
A single “source of truth” definition
Makes it easy for technical writers
![Page 23: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/23.jpg)
Making sales tax less taxing 23CONFIDENTIAL & PROPRIETARY |
Swagger accurately reflects API?
![Page 24: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/24.jpg)
Making sales tax less taxing 24CONFIDENTIAL & PROPRIETARY |
Follows company style guide?
![Page 25: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/25.jpg)
Making sales tax less taxing 25CONFIDENTIAL & PROPRIETARY |
![Page 26: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/26.jpg)
Making sales tax less taxing 26CONFIDENTIAL & PROPRIETARY |
We still need people!
• Human-‐readable property definitions
• Define business flows
• Describe best practices
![Page 27: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/27.jpg)
Making sales tax less taxing 27CONFIDENTIAL & PROPRIETARY |
![Page 28: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/28.jpg)
Making sales tax less taxing 28CONFIDENTIAL & PROPRIETARY |
![Page 29: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/29.jpg)
Making sales tax less taxing 29CONFIDENTIAL & PROPRIETARY |
2. https://upload.wikimedia.org/wikipedia/commons/a/af/Bedarra_Island_aerial.jpg3. https://upload.wikimedia.org/wikipedia/commons/7/7e/Palau_archipelago.jpg5. https://pixabay.com/p-35105/7. https://www.flickr.com/photos/nelsonminar/2868411138. https://upload.wikimedia.org/wikipedia/commons/e/eb/Bicycle_shed.JPG10. https://commons.wikimedia.org/wiki/File:United_States_Code_Law_Book_Boston_Public_Library_6D2B1951.jpg11. https://www.flickr.com/photos/dominicotine/769668144612. https://c1.staticflickr.com/3/2451/3704243811_55b45a0fd0_b.jpg15. https://commons.wikimedia.org/wiki/File:Dog_dressed_in_an_airplane_outfit.jpghttp://ichef-1.bbci.co.uk/news/640/media/images/67206000/jpg/_67206577_de25.jpg16. http://s3.freefoto.com/images/21/11/21_11_7_web.jpg19. https://c2.staticflickr.com/4/3220/2936038678_06ae77a09d.jpghttps://www.flickr.com/photos/dapuglet/8479185386https://c1.staticflickr.com/3/2792/4195466130_cdccf7f7c3_b.jpghttps://c1.staticflickr.com/3/2819/9190710208_cd972cd9c1.jpghttps://c1.staticflickr.com/1/2/1616041_2f42627c7b.jpghttps://pixabay.com/p-309065/20. https://www.flickr.com/photos/mbtrama/325408685https://www.flickr.com/photos/8113246@N02/820325896523. https://www.flickr.com/photos/jurvetson/687743449125. https://upload.wikimedia.org/wikipedia/commons/thumb/0/0b/Sandro_Botticelli_-_La_nascita_di_Venere_-_Google_Art_Project_-_edited.jpg/1280px-Sandro_Botticelli_-_La_nascita_di_Venere_-_Google_Art_Project_-_edited.jpg26. https://upload.wikimedia.org/wikipedia/commons/thumb/e/e7/Quill_(PSF)_vector.svg/2000px-Quill_(PSF)_vector.svg.png27. https://www.flickr.com/photos/portland_mike/969236814
Image Credits
![Page 30: API Description to Developer Portal: Translating and Testing your Documentation](https://reader033.vdocument.in/reader033/viewer/2022050614/5888b6121a28ab80248b6211/html5/thumbnails/30.jpg)
Making sales tax less taxing 30CONFIDENTIAL & PROPRIETARY |
Thanks!
Anya StettlerProduct Manager, APIAvalara
anyarms