Apigee에서는 포털을 빌드할 때 다음 섹션에 설명된 권장사항을 적용하는 것을 권장합니다.
잠재고객의 참여 유도하기
시각적으로 잠재고객 참여를 유도하여 고객으로 하여금 더 알아보고 싶게 만드는 콘텐츠를 추가하세요. API 소비자가 로그인하지 않고도 포털의 일부분을 탐색할 수 있도록 사용 설정합니다. 셀프서비스 등록을 제공하여 사용자가 API로 앱을 빌드하기 위해 빠르게 시작 및 실행할 수 있도록 합니다.
사용자가 API를 사용하도록 허용
OpenAPI 사양에서 대화형 API 참고 리소스를 자동 생성하면 사용자가 다음을 수행할 수 있습니다.
키워드가 관련성이 있고 적절한 경우 콘텐츠에 키워드를 포함합니다. 페이지에 키워드 문자열이 보이면 페이지의 검색 결과 순위가 향상될 수 있습니다. 사용자가 콘텐츠를 검색할 때 사용할 수 있는 키워드 문자열을 예측해 보세요. 아무 키워드나 사용하지 않도록 합니다. 즉, 검색 순위를 향상시키는 목적으로만 키워드를 과도하게 사용하지 마세요. 이렇게 하면 검색엔진에 의해 사이트에 페널티가 적용될 수 있습니다.
콘텐츠를 검색하는 사용자는 관련성이 높은 항목을 찾을 가능성이 높습니다.
개발자 커뮤니티 구축
소셜 미디어를 사용하여 Facebook, Twitter 등의 표준 소셜 채널을 통해 API 커뮤니티를 홍보합니다. API 커뮤니티에서 개발자 간 소통 및 상호작용을 촉진하는 블로그와 포럼을 게시합니다.
[[["이해하기 쉬움","easyToUnderstand","thumb-up"],["문제가 해결됨","solvedMyProblem","thumb-up"],["기타","otherUp","thumb-up"]],[["이해하기 어려움","hardToUnderstand","thumb-down"],["잘못된 정보 또는 샘플 코드","incorrectInformationOrSampleCode","thumb-down"],["필요한 정보/샘플이 없음","missingTheInformationSamplesINeed","thumb-down"],["번역 문제","translationIssue","thumb-down"],["기타","otherDown","thumb-down"]],["최종 업데이트: 2025-08-18(UTC)"],[[["\u003cp\u003eThis page outlines best practices for building an engaging and effective developer portal using Apigee and Apigee hybrid.\u003c/p\u003e\n"],["\u003cp\u003eCreating user-friendly URLs, descriptive portal names, and intuitive navigation are crucial for enhancing searchability and user experience.\u003c/p\u003e\n"],["\u003cp\u003eEnabling interactive API documentation with live request and response capabilities allows users to quickly understand and test your APIs.\u003c/p\u003e\n"],["\u003cp\u003eIncorporating relevant content like tutorials and use case examples, that are based on various audience levels will improve the user experience.\u003c/p\u003e\n"],["\u003cp\u003eUtilizing social media and community features such as forums and blogs will help to build a stronger developer community.\u003c/p\u003e\n"]]],[],null,["# Best practices for building your portal\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\n\u003cbr /\u003e\n\nApigee recommends that you apply the best practices described in the following sections when building your portal.\n\nEngage your audience\n--------------------\n\nAdd content that engages your audience visually and compels them to want to learn more. Enable API consumers to explore a portion of your portal without logging in. Provide self-service registration so they can get up and running quickly to build apps using your APIs.\n\nLet users try your APIs\n-----------------------\n\nAuto-generate interactive API documentation from your OpenAPI Specifications to enable users to:\n\n- Learn about the API\n- Send a live request to the API\n- View a live response returned from the API\n\n For more information, see [Publishing your APIs](/apigee/docs/api-platform/publish/portal/publish-apis).\n\nAddress primary learning paths\n------------------------------\n\nProvide use case examples and tutorials that are relevant to your audience and based on their level of experience. Demonstrate by example, such as a simple curl command sequence, or step through a more elaborate procedure.\n| You can learn from your internal consumers. Perform usability tests with internal consumers and revise content based on their feedback.\n\nImplement search engine optimization (SEO)\n------------------------------------------\n\nEnsure your content is searchable. Invest in SEO that improves your ranking in search results and enable users to find your content.\n\nUse the following best practices when structuring your content. For more information and additional guidelines from Google, see the [Google Search Engine Optimization Starter Guide](http://static.googleusercontent.com/media/www.google.com/en//webmasters/docs/search-engine-optimization-starter-guide.pdf).\n\nBuild a developer community\n---------------------------\n\nEmploy social media to promote your API community through standard social channels, such as Facebook, Twitter, and so on. Publish blogs and forums that foster communication and interaction among the developers in your API community."]]
