Web services documentation

Patent metadata

Field	Value
Publication number	US-2016359984-A1
Application number	US-201514730274-A
Country	US
Kind code	A1
Filing date	Jun 4, 2015
Priority date	Jun 4, 2015
Publication date	Dec 8, 2016
Grant date	—

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. A corresponding computer program product and computer system are also disclosed herein.

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; responsive to the documentation request, preparing a response that includes documentation corresponding to the application service; and transmitting the response to the requester.

2 . The method of claim 1 , further comprising receiving, at the endpoint, a service request for the application service and responding to the service request.

3 . The method of claim 1 , wherein the endpoint is a web services endpoint or a cloud services endpoint.

4 . The method of claim 1 , wherein the application service is stateless.

5 . The method of claim 1 , wherein the documentation specifies an input data schema and an output data schema.

6 . The method of claim 1 , wherein the documentation comprises an example or template.

7 . The method of claim 1 , wherein the documentation request indicates a requested format.

8 . The method of claim 7 , wherein the requested format is selected from the group consisting of XML, JSON, HTML, and WADL.

9 . The method of claim 7 , wherein the wherein the requested format indicates a template or example.

10 . A computer program product comprising:
one or more computer readable storage media and program instructions stored on the one or more computer readable storage media, the program instructions comprising instructions to: receive, at an endpoint configured to provide an application service, a documentation request from a requester; responsive to the documentation request, prepare a response that includes documentation corresponding to the application service; and transmit the response to the requester.

11 . The computer program product of claim 10 , wherein the program instructions comprising instructions to receive, at the endpoint, a service request for the application service and respond to the service request.

12 . The computer program product of claim 10 , wherein the endpoint is a web services endpoint or a cloud services endpoint.

13 . The computer program product of claim 10 , wherein the documentation specifies an input data schema and an output data schema.

14 . The computer program product of claim 10 , wherein the documentation comprises an example or template.

15 . The computer program product of claim 10 , wherein the documentation request indicates a requested format.

16 . A computer system comprising:
one or more computers; one or more computer readable storage media and program instructions stored on the one or more computer readable storage media for execution by at least one of the computers, the program instructions comprising instructions to: receive, at an endpoint configured to provide an application service, a documentation request from a requester; responsive to the documentation request, prepare a response that includes documentation corresponding to the application service; and transmit the response to the requester.

17 . The computer system of claim 16 , wherein the program instructions comprising instructions to receive, at the endpoint, a service request for the application service and respond to the service request.

18 . The computer system of claim 16 , wherein the documentation specifies an input data schema and an output data schema.

19 . The computer system of claim 16 , wherein the documentation comprises an example or template.

20 . The computer system of claim 16 , wherein the documentation request indicates a requested format.

Assignees

• IBM

Inventors

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

Classifications

• H04L67/142 Primary

  Managing session states for stateless protocols; Signalling session states; State transitions; Keeping-state mechanisms · CPC title

• H04L67/02 Primary

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

• H04L67/327

  Electricity · mapped topic

• G06F16/83

  Querying · CPC title

• H04L67/63

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