Guys, when you write an API docs for an integratio...
# suitescriptm
Marwan
05/26/2021, 5:30 PMGuys, when you write an API docs for an integration, what do you use? Swagger? Apiary? Just PDF file?
s
stalbert
05/26/2021, 5:47 PMwe often take a lighter approach, especially for bespoke development. e.g. just JSON-schema and/or TypeScript interfaces to define the shape of api operations, inputs and outputs.
b
bbahrman
05/26/2021, 9:54 PM@Marwan I take stalbert's approach most of the time, but just stumbled on this article. Might be helpful if you work with WebStorm: https://blog.jetbrains.com/webstorm/2020/08/working-with-rest-apis-in-webstorm/
bbahrman
05/26/2021, 10:18 PMTheoretically you can test APIs from WebStorm, I'm trying to determine if it can handle oauth 1.0 though
bbahrman
05/26/2021, 10:27 PMPostman also has good auto generation which might be easier than anything else
bbahrman
05/26/2021, 10:27 PMSorry for all the messages on the thread, I'm building out an API right now so working through documentation
s
stalbert
05/26/2021, 11:47 PMNo, AFAIK webstorm's built in stuff doesn't do OAuth - it's a requested feature though. That said, we prefer to write repeatable automated tests (jest) anyway, so using an OAuth library to do TBA is no problem.