// css

Beautiful gRPC Docs, and the Organization Concept | GenDocu v0.6


One step closer to replacing non-standardized REST APIs with gRPC APIs.

We’re consistently working to improve your gRPC API Reference. Through this release, we will help you build beautiful, production-ready gRPC API docs without the need for a gRPC-Gateway (REST to gRPC). Collaborating with new organization features to build gRPC API has never been easier. Check refreshed Library App API or Official GenDocu API Documentation.

All those features are available for free.

Beautiful, Customizable API Reference - Editor Mode

We designed editor mode with a live preview to help you adjust your branding with the API reference. You can use one of the readymade color schemes or adjust every element independently - there are 24 different color settings, 24 color highlight templates, and two layout options. Integration of the same color schemes into our open-source version is still in progress.

Example 1

Example 2

Productive gRPC collaboration - the Organization Concept and Sharing the GitHub App Installation

/images/release-v0.6/project-members.png

Add users and collaborate effortlessly. Our previous project-based approach was far from perfect - gRPC APIs tend to be smaller but more numerous. Moreover, different APIs often shared the repository. That’s why we introduced the organization concept. You can add users to the organization and re-use the structure in every project you create - every organization’s permissions are automatically applied to their projects. Once activated, an installation of the GitHub App allows all organization’s users to use it.

Better Pricing, Where Better = Lower

We’re changing the scope of our plans – all project plans are being converted to organization plans, with no additional changes. All the limits are applied to the projects individually, so, for example, having a 1000 builds/month plan means you can trigger (number of projects) x 1000 builds/month.

Explaining the Intricacies of Your APIs - Content Creation

/images/release-v0.6/editor.png

For Editor mode, we have also introduced custom content creation. Previously, we supported content from your repository in Markdown format. The main problem with that approach was that it created a long feedback loop – the change needed to be committed and rebuilt. With v0.6, you can create content directly in the API Reference and see the changes live. Markdown from repository support is suspended.

Mono-Repositories and API-Only Mono-Repositories - Sub-API Selection

The gRPC API repository tends to be a large mono-repository – google-APIs repository is a great example. In v0.6, we introduced the possibility of selecting only sub-API documentation. We use all proto files defined in protoc-root directories to understand the API, but generate the documentation for only selected sub-API, such as Google Ads' API as distinct from the whole Google APIs repository. Since v0.5, we also support multi-root gRPC APIs.

Random Example Interpolation - Turned Off By Default

/images/release-v0.6/random-examples.png

That was one of the most asked-for enhancements. To improve our live-code examples, we implemented random interpolation: when there is no example for a given message, we tried to interpolate the value with random data. It sounded like a good idea, but it was very hard to do it properly. We tried to use the field name as a hint, but often it is impossible to interpolate data, such as the identifier format, correctly. You don’t have to define the example value for all messages to mitigate this issue – messages with no value will remain empty in code examples.

Choose the Next Feature - Introducing Voting

Our users are awesome! The amount of feedback and the time you have given us to help us build a better product is enormous. Your opinions are the most important factor in our business. As we’re growing, however, we struggle to find a time to talk to you all. That’s why we are introducing this win-win solution. Now you can suggest features more quickly in the App, without any scheduling or emails. This means we have more time to talk with you when you really need it!

Minor Updates

  • You can select the SDK Repository branch. Previously, we used the default master branch, but this got messed up when you had already created a repository with another default branch, e.g., Github’s main branch.
  • There was an issue with changing the source repository branch after project creation. We fixed that.
  • We refactored the API Reference UI, and now it loads and renders faster.
  • After we released the organization plan feature to Beta users, it was impossible to change the plan. We fixed that.
  • We have created a setup steps for Maven for Java.