PUBLIC - Liferay Portal Community Edition

Add Json WebServices discovery document

Details

  • Type: Story Story
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Completed
  • Affects Version/s: 6.2.0 CE M4
  • Fix Version/s: 6.2.0 CE M4
  • Component/s: API, API > Portal Service
  • Labels:
    None
  • Epic/Theme:
  • Story Points:
    3
  • Similar Issues:
    Show 5 results 

Description

Similar to the concept of WSDL, lets add json-based document for describing all api services.

this can be invoked like:

/api/jsonws?list

or to narrow down the list to certain service(s):

/api/jsonws?list=/dlapp/*,/user/*

This would also help to automatically build the clients.

Activity

Hide
Permalink
Igor Spasic added a comment - - edited

Current example of discovery document:

{
  "context": "/batman-portlet",
  "basePath": "/api/jsonws",
  "baseUrl": "http://localhost:8080/batman-portlet/api/jsonws",
  "methods": {
    "/batasset/call1": {
      "path": "/batasset/call1",
      "parameters": {
        "id": "long",
        "value": "string"
      },
      "httpMethod": "POST",
      "response": "void"
    },
    "/batasset/hello": {
      "path": "/batasset/hello",
      "parameters": {
        
      },
      "httpMethod": "POST",
      "response": "void"
    },
    "/batasset/invoke-method": {
      "path": "/batasset/invoke-method",
      "parameters": {
        "name": "string",
        "parameterTypes": "string[]",
        "arguments": "object[]"
      },
      "httpMethod": "POST",
      "response": "object"
    }
  }
}
Show
Igor Spasic added a comment - - edited Current example of discovery document: { "context" : "/batman-portlet" , "basePath" : "/api/jsonws" , "baseUrl" : "http: //localhost:8080/batman-portlet/api/jsonws" , "methods" : { "/batasset/call1" : { "path" : "/batasset/call1" , "parameters" : { "id" : " long " , "value" : "string" }, "httpMethod" : "POST" , "response" : "void" }, "/batasset/hello" : { "path" : "/batasset/hello" , "parameters" : { }, "httpMethod" : "POST" , "response" : "void" }, "/batasset/invoke-method" : { "path" : "/batasset/invoke-method" , "parameters" : { "name" : "string" , "parameterTypes" : "string[]" , "arguments" : "object[]" }, "httpMethod" : "POST" , "response" : "object" } } }

People

Vote (0)
Watch (3)

Dates

  • Created:
    Updated:
    Resolved:
    Days since last comment:
    15 weeks ago