Examples with ApiDocObject com.terran4j.commons.api2doc.domain.ApiDocObject used on opensource projects

Example 6 with ApiDocObject

use of com.terran4j.commons.api2doc.domain.ApiDocObject in project commons by terran4j.

the class CurlBuilderTest method testToCurlSimple.

@Test
public void testToCurlSimple() throws Exception {
    ApiDocObject doc = loadDoc("simple");
    String curl = CurlBuilder.toCurl(doc, serverURL);
    Assert.assertEquals("curl \\\n" + " -H \"myHeader: myHeader\" \\\n" + " -b \"myCookie=myCookie\" \\\n" + " -d \"myParam=myParam\" \\\n" + " \"http://localhost:8080/api/v1/curl/normal/0/abc/p2\"", curl);
}

Example 7 with ApiDocObject

use of com.terran4j.commons.api2doc.domain.ApiDocObject in project commons by terran4j.

the class ParseApiCommentOnSeeClassLoop method testParseApiCommentOnSeeClassLoop.

@Test
public void testParseApiCommentOnSeeClassLoop() throws Exception {
    log.info("testParseApiCommentOnSeeClass");
    Api2DocCollector collector = new Api2DocCollector();
    ApiFolderObject folder = collector.toApiFolder(new ParseApiCommentOnSeeClassLoop.MyController(), "myController");
    ApiDocObject doc = folder.getDoc("updateUser");
    List<ApiParamObject> params = doc.getParams();
    Assert.assertEquals("用户id", params.get(0).getComment().toString());
    Assert.assertEquals("123", params.get(0).getSample().toString());
    Assert.assertEquals("用户名称", params.get(1).getComment().toString());
    Assert.assertEquals("neo", params.get(1).getSample().toString());
    ApiResultObject user = doc.getResults().get(0);
    ApiResultObject userId = user.getChildren().get(0);
    Assert.assertEquals("id", userId.getId());
    Assert.assertEquals("用户id", userId.getComment().getValue());
    Assert.assertEquals("123", userId.getSample().getValue());
    ApiResultObject userName = user.getChildren().get(1);
    Assert.assertEquals("name", userName.getId());
    Assert.assertEquals("用户名称", userName.getComment().getValue());
    Assert.assertEquals("neo", userName.getSample().getValue());
}

Example 8 with ApiDocObject

use of com.terran4j.commons.api2doc.domain.ApiDocObject in project commons by terran4j.

the class Api2DocUtilsTest method testToURL.

@Test
public void testToURL() throws Exception {
    log.info("testToURL");
    Api2DocCollector collector = new Api2DocCollector();
    ApiFolderObject folder = collector.toApiFolder(new Api2DocUtilsTestController(), "userController");
    ApiDocObject doc = folder.getDoc("getUser");
    String url = Api2DocUtils.toURL(doc, serverURL);
    Assert.assertEquals("http://localhost:8080/api/v1/user/123", url);
    doc = folder.getDoc("getUser2");
    url = Api2DocUtils.toURL(doc, serverURL);
    Assert.assertEquals("http://localhost:8080/api/v1/user2/0", url);
    doc = folder.getDoc("getUsers");
    url = Api2DocUtils.toURL(doc, serverURL);
    Assert.assertEquals("http://localhost:8080/api/v1/group/3/users?" + "age=30&city=%E5%8C%97%E4%BA%AC", url);
}

Example 9 with ApiDocObject

use of com.terran4j.commons.api2doc.domain.ApiDocObject in project commons by terran4j.

the class CurlBuilderTest method loadDoc.

private ApiDocObject loadDoc(String methodName) throws BusinessException {
    ApiFolderObject folder = collector.toApiFolder(new CurlBuilderTest(), "curlBuilderTest");
    ApiDocObject doc = folder.getDoc(methodName);
    Assert.assertNotNull(doc);
    return doc;
}

Example 10 with ApiDocObject

use of com.terran4j.commons.api2doc.domain.ApiDocObject in project commons by terran4j.

the class CurlBuilderTest method testToCurlWithComment.

@Test
public void testToCurlWithComment() throws Exception {
    ApiDocObject doc = loadDoc("withComment");
    String curl = CurlBuilder.toCurl(doc, serverURL);
    Assert.assertEquals("curl \\\n" + " -H \"k2: false\" \\\n" + " -b \"k3=5.86\" \\\n" + " -d \"k1=k123\" \\\n" + " \"http://localhost:8080/api/v1/curl/comment/123/abc\"", curl);
}