변경 API 경로 이름 동안 목록 API의

우리는 우리가 swagger UI 다음변경 API 경로 이름 동안 목록 API의

이

exports.people = { 
    'spec': 
    { 
    path : "/people", 
    method: "POST", 
    summary : "Create new person", 
    notes : "Create new person", 
    nickname : "people",  
    parameters : [param.query("email", "email", "string", true), 
        param.query("firstName", "firstName", "string", true), 
        param.query("lastName", "lastName", "string", true)] 
    }, 
    'action': function(req, res) 
    { 

     -----code---- 
    } 
}

는 요청 URL 생성하기위한 샘플 코드 사용이에 대한 응용 프로그램의 모든 API의의를 문서화하는

로

http://localhost:8080/rest/api/people

따라서 사람들을위한 경로는 /people으로 생성되지만이를 "/ create_people '로 변경해야합니다. 그러면이 functi를 어떻게 구현할 수 있습니까? onality.

우리가 여기 spec의 "경로"를 변경하여이 시도가 작동되는 코드

exports.people = { 
    'spec': 
    { 
    path : "/create_people", 
    .....// rest of code

하지만 우리가이 잘못되는

http://localhost:8080/rest/api/create_people

를 따를 때 서로 다른 리디렉션 URL을 생성 요청 URL이 아닌 API 이름 만 변경하십시오.

여기에 그림이 나와 있습니다. enter image description here

우리는 자신감-UI이 일반적으로 좋은 생각이 아니다라고하여 Node.js를

출처

2014-11-11 user2622247

당신이 묻는 것은 많은 의미가 없습니다. "/ people"은 문서의 일부로 사용되는 실제 경로입니다. 디스플레이를 변경하려고하지만 실제 경로를 기준으로 작업을 수행하려고합니다. 왜 그렇게하고 싶은지 알 수 없으며 사용자를 혼란스럽게 할뿐입니다. – Ron

내 고객이 원하고 그것이 가능할까요? – user2622247

내가 시작합니다을 사용하고 있습니다. 설명서의 목적은 사용자에게 사용 가능한 작업을 설명하고 여기서 직접적인 정보를 숨기려는 것입니다. 결국 그 열의 오른쪽에 "Create new person (새 사람 만들기)"이라는 설명이 있습니다.

Swagger 1.2를 사용하여 설정하는 것은 쉬운 일이 아닙니다. 원하는 출력을 얻으려면 Swagger 설명서와 UI를 해킹해야합니다. 해킹 된 사양을 사용하려는 타사 도구가 제대로 작동하지 않을 수 있습니다.

Swagger 2.0에서 확장 속성 x-을 사용할 수 있으며 "x-alternative-display": "/create_person"과 같으며 표시 할 경로 대신 해당 특성을 사용하도록 UI를 변경할 수 있습니다.

출처

2014-11-11 16:14:25 Ron

변경 API 경로 이름 동안 목록 API의

답변

관련 문제