StackShare
May 1, 2019
Needs advice
382k views382k
CommentsApiary vs Slate
Overview
Share your Stack
Help developers discover the tools you use. Get visibility for your team's tech choices and contribute to the community's knowledge.
CLI (Node.js)
Manual
Advice on Apiary, Slate
Detailed Comparison
It takes more than a simple HTML page to thrill your API users. The right tools take weeks of development. Weeks that apiary.io saves. | Slate helps you create beautiful API documentation. Think of it as an intelligent, responsive documentation template for your API. |
Documentation- Organized around resources, code samples with syntax highlight, easy to explore.;Inspector- Users can make API calls through apiary.io, we show them how they differ from documentation.;Community- Opensource your API documentation on GitHub. The right channel between developers on both side of the API.;Always Tested [closed alpha]- The documentation is always watching your real API and tells you whenever it gets out of sync.;Server Mock- The fastest way to static API prototype—just ‘document’ your future API and it’s up. 2 minutes to Hello World.;GitHub Integration- Store the API Blueprint in your repository, everything gets updated as soon as you commit a new version.;I/O Validation- Add a JSON Schema to the API Blueprint and the proxy will help your API users understand implementation of data structures better.;Customization [closed alpha]- The documentation and tools can be seamlessly placed on your website and gray-labeled so the friction is close to none. | Clean, intuitive design — with Slate, the description of your API is on the left side of your documentation, and all the code examples are on the right side. Inspired by Stripe's and Paypal's API docs. Slate is responsive, so it looks great on tablets, phones, and even print.;Everything on a single page — gone are the days where your users had to search through a million pages to find what they wanted. Slate puts the entire documentation on a single page. We haven't sacrificed linkability, though. As you scroll, your browser's hash will update to the nearest header, so linking to a particular point in the documentation is still natural and easy.;Slate is just Markdown — when you write docs with Slate, you're just writing Markdown, which makes it simple to edit and understand. Everything is written in Markdown — even the code samples are just Markdown code blocks!;Write code samples in multiple languages — if your API has bindings in multiple programming languages, you easily put in tabs to switch between them. In your document, you'll distinguish different languages by specifying the language name at the top of each code block, just like with Github Flavored Markdown!;Out-of-the-box syntax highlighting for almost 60 languages, no configuration required.;Automatic, smoothly scrolling table of contents on the far left of the page. As you scroll, it displays your current position in the document. It's fast, too. We're using Slate at TripIt to build documentation for our new API, where our table of contents has over 180 entries. We've made sure that the performance remains excellent, even for larger documents.;Let your users update your documentation for you — by default, your Slate-generated documentation is hosted in a public Github repository. Not only does this mean you get free hosting for your docs with Github Pages, but it also makes it's simple for other developers to make pull requests to your docs if they find typos or other problems. Of course, if you don't want to, you're welcome to not use Github and host your docs elsewhere! |
Statistics | |
Stacks 241 | Stacks 101 |
Followers 325 | Followers 130 |
Votes 109 | Votes 8 |
Pros & Cons | |
Pros
| Pros
|
Integrations | |
| No integrations available | |
What are some alternatives to Apiary, Slate?
Postman
It is the only complete API development environment, used by nearly five million developers and more than 100,000 companies worldwide.
Swagger UI
Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation and sandbox from a Swagger-compliant API
ReadMe.io
It is an easy-to-use tool to help you build out documentation! Each documentation site that you publish is a project where there is space for documentation, interactive API reference guides, a changelog, and much more.
Docusaurus
Docusaurus is a project for easily building, deploying, and maintaining open source project websites.
Read the Docs
It hosts documentation, making it fully searchable and easy to find. You can import your docs using any major version control system, including Mercurial, Git, Subversion, and Bazaar.
Gelato.io
Gelato.io is a SaaS tool for creating API documentation and developer portals.
MireDot
Generate REST documentation directly from your Java source code. This ensures always up-to-date and accurate documentation with minimal effort.
Gitbook
It is a modern documentation platform where teams can document everything from products, to APIs and internal knowledge-bases. It is a place to think and track ideas for you & your team.
jsdoc
JSDoc 3 is an API documentation generator for JavaScript, similar to JavaDoc or PHPDoc. You add documentation comments directly to your source code, right along side the code itself. The JSDoc Tool will scan your source code, and generate a complete HTML documentation website for you.
Ardoq
Ardoq's out of the box visualizations are automatically created in real-time. All changes and relationships are visualized simultaneously and are context sensitive. With Ardoq, you can see your documentation in the perspectives that best suit your needs.
