2014-08-31 4 views
2

안녕하세요, 저는 Microsoft의 Azure 모바일 서비스에 관한 질문이 있습니다. Azure 모바일 서비스 포털 (URL <의 이름을 입력하십시오.> .azure-mobile.net)에 대한 문서를 작성하여 요청할 때 사용자 정의 API가 수행해야하는 작업을 내 친구에게 알리고 싶습니다. 나는 그것을 주위에 봤지만 아무 것도 발견하지 못했고, 표준 C# 스타일 문서는 아무 것도 보여주지 못했다. 사이트에서 문서가 없거나 종류가 알려주므로 문서화 할 수 있어야합니다.Azure 모바일 서비스 백엔드 문서 작성

+0

이 "문제"에 대한 해결책을 찾으십시오. 나는 내 API를 문서화하기 위해 고심하고 있으며, 그렇게 어렵지 않아야한다고 생각한다 ... – Matheus

+0

Nope mate. Api 관리는 근본적으로 api 호출을 제한하기 때문에 기본적으로 서버 측보다 더 공개적이며, 하늘에서 마스터 키로 만 연결할 수 있습니다. – Citrus

+0

또한 아래의 대답은 다소 관련이 있습니다. Doxygen 형식의 문서를 사용하여 문서를 생성 해 보았으나 지금까지는 시가가 없었습니다. – Citrus

답변

1

도움말 페이지에 표준 C# 설명서를 표시하는 것은 매우 간단합니다. 이것에 대한 기본적


:

API Help Page

당신이해야 할 모든은 다음과 같습니다 :

    /// <summary> 
        /// Creates a new user account. 
        /// </summary> 
        /// <param name="model">Object containing the basic information about the user.</param> 
        /// <returns>User with the basic data and the JWT token.</returns> 
        /// <exception cref="BusinessLogicException"> 
        /// Throws business exception if the user that is being created contains invalid data, such as invalid email, username and so on. 
        /// </exception> 
        public async Task<ResponseMessage<UserLogin>> Post(PostUserModel model) 
        { 
         ... 
        } 
    

    이되기 위해

  1. 마우스 오른쪽 단추로 속성으로 이동
  2. (비주얼 스튜디오 내에서) 모바일 서비스 .NET 프로젝트 프로젝트를 클릭
  3. 확인 "XML 문서 파일"체크 박스 (이미지 울부 짖는 소리) 자세한 내용은

Properties Windows

도움말 페이지 사용자 정의 옵션을 보려면 다음 리소스를 따르십시오. http://www.codeproject.com/Articles/819848/Master-the-Managed-Azure-Mobile-Services-Backend

+0

고마워 폐하! 늦어서 미안해, 어제 내가 이걸 다시 보았던 날이었다. – Citrus

0

Azure API 관리를 사용해보십시오. 또한 설명서, 테스트 콘솔 등을 보유한 사용자 용 개발자 포털을 만들고 분석, 할당량 등을 제공하는 관리 포털도 만들 것입니다. 자세한 내용은 here을 참조하십시오.

관련 문제