Deprecated: Function create_function() is deprecated in /home/qualit96/public_html/wp-content/plugins/revslider/includes/framework/functions-wordpress.class.php on line 258

Warning: Cannot modify header information - headers already sent by (output started at /home/qualit96/public_html/wp-content/plugins/revslider/includes/framework/functions-wordpress.class.php:258) in /home/qualit96/public_html/wp-includes/feed-rss2-comments.php on line 8
Comments on: Develop your API Contracts https://quality-spectrum.com/develop-your-api-contracts/ Redefining software quality Sun, 26 Jan 2020 16:25:05 +0000 hourly 1 https://wordpress.org/?v=5.5 By: Ali Khalid https://quality-spectrum.com/develop-your-api-contracts/comment-page-1/#comment-23874 Sun, 26 Jan 2020 16:25:05 +0000 http://quality-spectrum.com/?p=15019#comment-23874 In reply to Maria.

For API’s the service provider should write a ‘contract’ (behavior) of the format of requests to send to the API, and what will be sent back in response. Essentially requirements of how the API will behave. These are called contracts, because it’s an agreement between the service provider and user of how the API will behave.

Documenting the ‘contract’ can be done through a wiki / confluence page, but best practice dictates to use API documentation tools like swagger, this was the contract is documented from the actual code, not a static document which have to keep up to date all the time.

]]>
By: Maria https://quality-spectrum.com/develop-your-api-contracts/comment-page-1/#comment-23540 Thu, 23 Jan 2020 11:16:05 +0000 http://quality-spectrum.com/?p=15019#comment-23540 What do you mean by conttact written up? Can you give an example, please?

]]>