Search in sources :

Example 11 with ApiDocObject

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

the class ParseApiCommentOnSeeClass method testParseApiCommentOnSeeClass.

@Test
public void testParseApiCommentOnSeeClass() throws Exception {
    log.info("testParseApiCommentOnSeeClass");
    Api2DocCollector collector = new Api2DocCollector();
    ApiFolderObject folder = collector.toApiFolder(new ParseApiCommentOnSeeClass.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());
}
Also used : Api2DocCollector(com.terran4j.commons.api2doc.impl.Api2DocCollector) ApiParamObject(com.terran4j.commons.api2doc.domain.ApiParamObject) ApiFolderObject(com.terran4j.commons.api2doc.domain.ApiFolderObject) ApiDocObject(com.terran4j.commons.api2doc.domain.ApiDocObject) ApiResultObject(com.terran4j.commons.api2doc.domain.ApiResultObject) Test(org.junit.Test)

Aggregations

ApiDocObject (com.terran4j.commons.api2doc.domain.ApiDocObject)11 Test (org.junit.Test)7 ApiFolderObject (com.terran4j.commons.api2doc.domain.ApiFolderObject)6 Api2DocCollector (com.terran4j.commons.api2doc.impl.Api2DocCollector)4 ApiParamObject (com.terran4j.commons.api2doc.domain.ApiParamObject)3 ApiResultObject (com.terran4j.commons.api2doc.domain.ApiResultObject)2 MenuData (com.terran4j.commons.api2doc.controller.MenuData)1 ArrayList (java.util.ArrayList)1