Web services documentation

Patent metadata

Field	Value
Publication number	US-9948702-B2
Application number	US-201615041065-A
Country	US
Kind code	B2
Filing date	Feb 11, 2016
Priority date	Jun 4, 2015
Publication date	Apr 17, 2018
Grant date	Apr 17, 2018

Abstract

A method for distributing documentation for an application service includes receiving, at an endpoint configured to provide an application service, a documentation request from a requester, preparing a response that includes documentation corresponding to the application service, and transmitting the response to the requester. The method may also include receiving, at the endpoint, a service request for the application service and responding to the service request. The documentation may conform to a requested format.

First claim

What is claimed is:

1. A method for distributing documentation for an application service, the method comprising:
receiving, at an endpoint configured to provide an application service, a documentation request from a requester, wherein the endpoint is a web services endpoint or a cloud services endpoint, and wherein the application service is maintained in a cloud network independently of a device local to a user of the requester, and wherein the cloud network comprises a private, community, public, or hybrid cloud network, and wherein the application service is stateless, and wherein the documentation request indicates a requested format, wherein the requested format is selected from the group consisting of XML, JSON, HTML, and WADL, and wherein the requested format indicates a template or example;
responsive to the documentation request, preparing a response that includes documentation, wherein the documentation specifies an input data schema and an output data schema for communicating with a service function of the application service, and wherein the documentation comprises an example or template;
transmitting the response to the requester; and
receiving, at the endpoint, a service request for the application service and responding to the service request.

Assignees

• IBM

Inventors

• Exton Scott A
• Farrell Leo M M
• Robinson Keiran W
• Smith Jasmine A

Classifications

• H04L67/327

  Electricity · mapped topic

• H04L67/02 Primary

  based on web technology, e.g. hypertext transfer protocol [HTTP] · CPC title

• G06F17/30923

  Physics · mapped topic

• H04L67/10 Primary

  in which an application is distributed across nodes in the network (software deployment G06F8/60; multiprogramming arrangements G06F9/46) · CPC title

• H04L67/63

  Routing a service request depending on the request content or context · CPC title