You use Cloud Endpoints Portal to create a developer portal, a website that users of your Cloud Endpoints API can access to explore and test your API. On your portal, developers who are using your API in their own code can find the SmartDocs API reference documentation. SmartDocs uses the OpenAPI document that Cloud Endpoints Frameworks creates to generate API reference documentation. SmartDocs includes a Try this API panel, so developers can interact with your API without leaving the documentation.
You can also provide your own custom documentation to help your users get started and be successful using your API.
Visit the Endpoints Portal Demo to explore the portal that was created from several different Endpoints samples.
- Users must authenticate with a GCP project in order to access the developer portal. Unauthenticated users can't view the developer portal.
- The Endpoints service must be publicly accessible in order to use the Try this API panel. Requests will fail if other authentication (such as IAP) is configured on the Endpoints service.
- Getting started using the Endpoints Portal
- Updating the SmartDocs API reference documentation
- Trying out the API
- Adding custom documentation
- Setting up a custom domain