• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Jeanne Boyarsky
  • Ron McLeod
  • Paul Clapham
  • Liutauras Vilda
Sheriffs:
  • paul wheaton
  • Rob Spoor
  • Devaka Cooray
Saloon Keepers:
  • Stephan van Hulst
  • Tim Holloway
  • Carey Brown
  • Frits Walraven
  • Tim Moores
Bartenders:
  • Mikalai Zaikin

The Design of Web APIs: tools used for API design, design verification

 
Greenhorn
Posts: 25
Scala Spring Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
API design and development is a tedious and time consuming task. There are platforms such as Postman, Kong, SmartBear which provide tools for API development, management, testing. Do you use these tools in your API design work - for quick POC, verification of that design? Also there are other, API testing/verification tools, such as WireMock in particular. Please share your insight on that. Thanks.
 
Ranch Hand
Posts: 150
1
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator

Arnaud Lauret wrote:Hi,

In this book, I describe how to use the OpenAPI specification to design (chapter 4) and document the API (chapter 12) but I do not dive more in how to extensively take advantage of it (code generation, tool configuration, linting, ...) , that is not the purpose of the book which is focusing solely on design.

Arnaud

 
Author
Posts: 15
  • Likes 2
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Thank Ludoviko for the quote, indeed the book focus on design, talking about all tools to use along the API lifecycle would need another book. But I still can give you some insight about what I use.

To design APIs, I write plain OpenAPI Specification files either using Swagger Editor (https://github.com/swagger-api/swagger-editor) or VS Code with some extensions (https://marketplace.visualstudio.com/items?itemName=Arjun.swagger-viewer and https://marketplace.visualstudio.com/items?itemName=mermade.openapi-lint). If you're not into writing YAML, I recommend Stoplight Studio (https://github.com/stoplightio/studio).

If I need to run a mock of a design to see how it feels to use it, I use Stoplight Prism (https://github.com/stoplightio/prism)

When it comes to testing I recommend to do as much as you can low level unit testing (with your favorite tool) before mingling with the HTTP level with tools such as Postman or even the good old SoapUI and also ReadyAPI (from Smartbear).
 
Yury Nebieridze
Greenhorn
Posts: 25
Scala Spring Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Thanks for the detailed reply, Arnaud! It was a valuable insight.
 
The happiness of your life depends upon the quality of your thoughts -Marcus Aurelius ... think about this tiny ad:
a bit of art, as a gift, that will fit in a stocking
https://gardener-gift.com
reply
    Bookmark Topic Watch Topic
  • New Topic