slate
API-Portal
DISCONTINUED
Our great sponsors
slate | API-Portal | |
---|---|---|
21 | 2 | |
35,788 | 171 | |
0.3% | - | |
4.4 | 0.0 | |
9 days ago | 11 months ago | |
SCSS | TypeScript | |
Apache License 2.0 | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
slate
-
10+ API Documentation Tools For Super Busy Developers 👩💻
Slate (Free)
-
How do i document my api ?
https://github.com/slatedocs/slate this ! Big company use it ( stripe etc )
-
Twelve Amazing Free Hugo Documentation Themes
DocuAPI is a multilingual API documentation theme for Hugo created and maintained by Bjørn Erik Pedersen, the lead maintainer and co-creator of Hugo itself. It’s built on top of the Slate API docs generator, which itself was inspired by Stripe’s and PayPal’s API docs. The JavaScript section of DocuAPI has been rewritten from Jquery to AlpineJS.
-
Create and deploy API documentation to Kubernetes
If you are going to use Slate from the console you need to install it, along with all its prerequisites, as described here. In Ubuntu you can execute the commands:
-
How does Stripe create this style of documentation?
Slate - API Generator
- Building API Docs
-
What would you like to see Stripe improve on iOS?
I'm using Slate right now which is a common recommendation for Stripe-like documentation, but obviously it's not the same.
-
Favorite API Documentation UI/UX
While not as visually impressive with flashy graphics and UI elements, Twilio's documentation has similar Stripe vibes as I believe it's built on Slate which is about as close to Stripe's framework as you can get. I like the theme used[4] in the code sample section as it's a nice break from the standard colors and it's easy on the eyes.
-
Best toolset/workflow for prototyping and iterating an API?
That's about the API design and specification. Now let's turn our attention to API UIs for visualisation and interaction. API UIs are useful for other people to easily understand your API. Again, quite a variety of choices in this area, but the most common are Swagger UI and Redoc. Lots of frameworks and tools will allow you to render the Swagger or Redoc UI of an OpenAPI spec from the specification document, such as Swagger's editor. And if you're comfortable enough with JavaScript, you can do the rendering yourself using the npm package. A fancier UI is Slate. I don't know whether Slate will automatically generate code samples in every popular language, but it does allow you to write the samples yourself. There're various tools that render a Slate UI from an OpenAPI specification. I believe Postman also allows you to generate a fancy UI.
-
Best platform for writing api docs?
For API-specific docs I use Slate as I like the code sample section off to the right. I converted our previous severely lacking Swagger setup to a full-featured framework with Slate that has significantly reduced the number of support emails regarding API questions.
API-Portal
We haven't tracked posts mentioning API-Portal yet.
Tracking mentions began in Dec 2020.
What are some alternatives?
redoc - 📘 OpenAPI/Swagger-generated API Reference Documentation
swagger-ui - Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
django-rest-framework - Web APIs for Django. 🎸
docusaurus-openapi - 🦕 OpenAPI plugin for generating API reference docs in Docusaurus v2.
Docusaurus - Easy to maintain open source documentation websites.
mkdocs
Hugo - The world’s fastest framework for building websites.
widdershins - OpenAPI / Swagger, AsyncAPI & Semoasa definitions to (re)Slate compatible markdown
prism - Turn any OpenAPI2/3 and Postman Collection file into an API server with mocking, transformations and validations.
insomnia - The open-source, cross-platform API client for GraphQL, REST, WebSockets, SSE and gRPC. With Cloud, Local and Git storage.
slant - Beautiful static documentation for your API