What is Gatsby and what are its top alternatives?
Gatsby is a popular static site generator that is based on React and GraphQL, offering a fast, efficient, and highly customizable way to build websites. Its key features include fast static site generation, data sourcing from various APIs, CMS platforms, and databases, out-of-the-box support for modern JavaScript features, easy deployment, and a large plugin ecosystem for extending functionality. However, some limitations of Gatsby include a steeper learning curve for beginners, potential performance issues with complex sites, and limited dynamic content capabilities compared to traditional server-side rendered websites.
- Next.js: Next.js is a React-based framework that offers server-side rendering, static site generation, and dynamic routing out of the box. Key features include automatic code splitting, hot module replacement, and TypeScript support. Pros of Next.js include excellent performance, easy deployment, and flexibility in choosing data fetching strategies, while cons may include a more complex setup process compared to Gatsby.
- Hugo: Hugo is a fast static site generator written in Go that is known for its speed and simplicity. Key features include flexible templating, content management, and a robust theme ecosystem. Pros of Hugo include blazing fast build times, easy customization, and a large community, while cons may include a steeper learning curve for beginners due to a different templating language.
- VuePress: VuePress is a minimalistic static site generator that is built on Vue.js, offering out-of-the-box Markdown support for documentation-centered sites. Key features include theme support, Vue-powered custom layouts, and Markdown extensions. Pros of VuePress include simplicity, Vue-powered components, and SEO-friendly features, while cons may include limited customization compared to Gatsby.
- SvelteKit: SvelteKit is a flexible web framework based on Svelte that offers server-side rendering or static site generation with highly optimized output. Key features include file-based routing, TypeScript support, and a built-in adapter for easy deployment. Pros of SvelteKit include small bundle sizes, smooth animations, and a component-centric approach, while cons may include a smaller ecosystem compared to Gatsby.
- Docusaurus: Docusaurus is a static site generator specifically designed for documentation websites, offering features like versioning, search functionality, and localization support. Key features include built-in MDX support, easy theming, and integration with popular version control systems. Pros of Docusaurus include focus on documentation needs, built-in search capabilities, and easy setup, while cons may include limited flexibility for non-documentation sites.
- Gridsome: Gridsome is a Vue.js-based framework that combines static site generation with a GraphQL data layer, allowing for fast and data-driven websites. Key features include source plugins for various data sources, progressive image loading, and a plugin ecosystem. Pros of Gridsome include easy data sourcing through GraphQL, Vue components for dynamic content, and GraphQL layer for advanced querying, while cons may include a smaller community compared to Gatsby.
- Eleventy: Eleventy is a simpler static site generator that requires minimal setup and can work with various templating languages like Markdown, Liquid, and Nunjucks. Key features include flexible templating, data cascading, and built-in support for multiple output formats. Pros of Eleventy include simplicity, flexibility in templating languages, and fast build times, while cons may include fewer out-of-the-box features compared to Gatsby.
- Nuxt.js: Nuxt.js is a Vue.js-based framework that offers server-side rendering, static site generation, and single-page application capabilities. Key features include automatic routing, Vuex integration, and middleware support. Pros of Nuxt.js include powerful routing options, built-in modules for common functionalities, and a large community, while cons may include complexity in choosing the right rendering mode for different applications.
- Jekyll: Jekyll is a Ruby-based static site generator that is known for its simplicity and ease of use, making it a popular choice for blogs and documentation sites. Key features include Liquid templating, YAML front matter, and built-in support for collections. Pros of Jekyll include quick setup, seamless GitHub integration, and extensive theme support, while cons may include slower build times for large sites compared to Gatsby.
- 11ty: 11ty is a simpler static site generator that requires minimal setup and can work with various templating languages like Markdown, Liquid, and Nunjucks. Key features include flexible templating, data cascading, and built-in support for multiple output formats. Pros of 11ty include simplicity, flexibility in templating languages, and fast build times, while cons may include fewer out-of-the-box features compared to Gatsby.
Top Alternatives to Gatsby
- Hugo
Hugo is a static site generator written in Go. It is optimized for speed, easy use and configurability. Hugo takes a directory with content and templates and renders them into a full html website. Hugo makes use of markdown files with front matter for meta data. ...
- Next.js
Next.js is a minimalistic framework for server-rendered React applications.
- React
Lots of people use React as the V in MVC. Since React makes no assumptions about the rest of your technology stack, it's easy to try it out on a small feature in an existing project. ...
- Jekyll
Think of Jekyll as a file-based CMS, without all the complexity. Jekyll takes your content, renders Markdown and Liquid templates, and spits out a complete, static website ready to be served by Apache, Nginx or another web server. Jekyll is the engine behind GitHub Pages, which you can use to host sites right from your GitHub repositories. ...
- Create React App
Create React apps with no build configuration.
- WordPress
The core software is built by hundreds of community volunteers, and when you’re ready for more there are thousands of plugins and themes available to transform your site into almost anything you can imagine. Over 60 million people have chosen WordPress to power the place on the web they call “home” — we’d love you to join the family. ...
- Postman
It is the only complete API development environment, used by nearly five million developers and more than 100,000 companies worldwide. ...
- Postman
It is the only complete API development environment, used by nearly five million developers and more than 100,000 companies worldwide. ...
Gatsby alternatives & related posts
- Lightning fast47
- Single Executable29
- Easy setup26
- Great development community24
- Open source23
- Write in golang13
- Not HTML only - JSON, RSS8
- Hacker mindset8
- LiveReload built in7
- Gitlab pages integration4
- Easy to customize themes4
- Very fast builds4
- Well documented3
- Fast builds3
- Easy to learn3
- No Plugins/Extensions4
- Template syntax not friendly2
- Quick builds1
related Hugo posts
There’s no doubt WordPress is a great CMS, which is very user friendly. When we started the company, our blog wasn’t really our top priority, and it ended up being hosted on a fairly obscure server within our setup, which didn’t really change much until recently when things become harder to manage and make significant updates.
As our marketing team increased, the amount of traffic that found us through our content marketing increased. We found ourselves struggling to maintain our Wordpress install given the amount of theme updates, plugins and security patches needing to be applied. Our biggest driver to find an alternative solution however was just how slow Wordpress is at serving content to the end user. I know there will be die hard fans out there with ways to set things up that mean WordPress sites can load quickly, but we needed something a lot more streamlined.
We could see in our own Real User Monitoring tool that many users were experiencing page load speeds of over five seconds, even longer in worst case scenarios. Hugo is an open source static site generator that has enabled us to reduce load times by over 500% and make our blog far more maintainable across the whole team.
The Raygun marketing site runs on a .NET CMS called N2 but we plan to swap that out with Hugo as well in future.
#StaticSiteGenerators #SelfHostedBloggingCms #SupportSalesAndMarketing
Depends on what options and technologies you have available, and how do you deploy your website.
There are CMSs which update existing static pages through FTP: You provide access credentials, mark editable parts of your HTML in a markup, and then edit the content through the hosted CMS. I know two systems which work like that: Cushy CMS and Surreal CMS.
If the source of your site is versioned through Git (and hosted on GitHub), you have other options, like Netlify CMS, Spinal CMS, Siteleaf, Forestry, or CloudCannon. Some of these also need you to use static site generator (like 11ty, Jekyll, or Hugo).
If you have some server-side scripting support available (typically PHP) you can also consider some flat-file based, server-side systems, like Kirby CMS or Lektor, which are usually simpler to retrofit into an existing template than “traditional” CMSs (WordPress, Drupal).
Finally, you could also use a desktop-based static site generator which provides a user-friendly GUI, and then locally generates and uploads the website. For example Publii, YouDoCMS, Agit CMS.
- Automatic server rendering and code splitting51
- Built with React44
- Easy setup34
- TypeScript26
- Universal JavaScript24
- Zero setup22
- Static site generator21
- Just JavaScript12
- Simple deployment12
- Incremental static regeneration12
- Filesystem as an API10
- Frictionless development10
- Everything is a function9
- Well Documented9
- Has many examples and integrations8
- Testing8
- Isomorphic React applications7
- File based routing + hooks built in4
- Deployment2
- SEO1
- Structure is weak compared to Angular(2+)9
related Next.js posts
Few years ago we were building a Next.js site with a few simple forms. This required handling forms validation and submission, but instead of picking some forms library, we went with plain JavaScript and constraint validation API in HTML5. This shaved off a few KBs of dependencies and gave us full control over the validation behavior and look. I describe this approach, with its pros and cons, in a blog post.
I'm working as one of the engineering leads in RunaHR. As our platform is a Saas, we thought It'd be good to have an API (We chose Ruby and Rails for this) and a SPA (built with React and Redux ) connected. We started the SPA with Create React App since It's pretty easy to start.
We use Jest as the testing framework and react-testing-library to test React components. In Rails we make tests using RSpec.
Our main database is PostgreSQL, but we also use MongoDB to store some type of data. We started to use Redis for cache and other time sensitive operations.
We have a couple of extra projects: One is an Employee app built with React Native and the other is an internal back office dashboard built with Next.js for the client and Python in the backend side.
Since we have different frontend apps we have found useful to have Bit to document visual components and utils in JavaScript.
- Components836
- Virtual dom673
- Performance578
- Simplicity508
- Composable442
- Data flow186
- Declarative166
- Isn't an mvc framework128
- Reactive updates120
- Explicit app state115
- JSX50
- Learn once, write everywhere29
- Easy to Use22
- Uni-directional data flow21
- Works great with Flux Architecture17
- Great perfomance11
- Javascript10
- Built by Facebook9
- TypeScript support8
- Scalable6
- Speed6
- Server Side Rendering6
- Feels like the 90s5
- Cross-platform5
- Closer to standard JavaScript and HTML than others5
- Easy as Lego5
- Functional5
- Excellent Documentation5
- Props5
- Awesome5
- Hooks5
- Easy to start5
- Scales super well4
- Allows creating single page applications4
- Sdfsdfsdf4
- Start simple4
- Strong Community4
- Super easy4
- Server side views4
- Fancy third party tools4
- Rich ecosystem3
- Has arrow functions3
- Very gentle learning curve3
- Beautiful and Neat Component Management3
- Just the View of MVC3
- Simple, easy to reason about and makes you productive3
- Fast evolving3
- SSR3
- Great migration pathway for older systems3
- Simple3
- Has functional components3
- Every decision architecture wise makes sense3
- Sharable2
- Permissively-licensed2
- HTML-like2
- Image upload2
- Recharts2
- Fragments2
- Split your UI into components with one true state2
- React hooks1
- Datatables1
- Requires discipline to keep architecture organized41
- No predefined way to structure your app30
- Need to be familiar with lots of third party packages29
- JSX13
- Not enterprise friendly10
- One-way binding only6
- State consistency with backend neglected3
- Bad Documentation3
- Error boundary is needed2
- Paradigms change too fast2
related React posts
I was building a personal project that I needed to store items in a real time database. I am more comfortable with my Frontend skills than my backend so I didn't want to spend time building out anything in Ruby or Go.
I stumbled on Firebase by #Google, and it was really all I needed. It had realtime data, an area for storing file uploads and best of all for the amount of data I needed it was free!
I built out my application using tools I was familiar with, React for the framework, Redux.js to manage my state across components, and styled-components for the styling.
Now as this was a project I was just working on in my free time for fun I didn't really want to pay for hosting. I did some research and I found Netlify. I had actually seen them at #ReactRally the year before and deployed a Gatsby site to Netlify already.
Netlify was very easy to setup and link to my GitHub account you select a repo and pretty much with very little configuration you have a live site that will deploy every time you push to master.
With the selection of these tools I was able to build out my application, connect it to a realtime database, and deploy to a live environment all with $0 spent.
If you're looking to build out a small app I suggest giving these tools a go as you can get your idea out into the real world for absolutely no cost.
Your tech stack is solid for building a real-time messaging project.
React and React Native are excellent choices for the frontend, especially if you want to have both web and mobile versions of your application share code.
ExpressJS is an unopinionated framework that affords you the flexibility to use it's features at your term, which is a good start. However, I would recommend you explore Sails.js as well. Sails.js is built on top of Express.js and it provides additional features out of the box, especially the Websocket integration that your project requires.
Don't forget to set up Graphql codegen, this would improve your dev experience (Add Typescript, if you can too).
I don't know much about databases but you might want to consider using NO-SQL. I used Firebase real-time db and aws dynamo db on a few of my personal projects and I love they're easy to work with and offer more flexibility for a chat application.
- Github pages integration74
- Open source54
- It's slick, customisable and hackerish37
- Easy to deploy24
- Straightforward cms for the hacker mindset23
- Gitlab pages integration7
- Best for blogging5
- Low maintenance2
- Easy to integrate localization2
- Huge plugins ecosystem1
- Authoring freedom and simplicity1
- Build time increases exponentially as site grows4
- Lack of developments lately2
- Og doesn't work with postings dynamically1
related Jekyll posts
I've heard that I have the ability to write well, at times. When it flows, it flows. I decided to start blogging in 2013 on Blogger. I started a company and joined BizPark with the Microsoft Azure allotment. I created a WordPress blog and did a migration at some point. A lot happened in the time after that migration but I stopped coding and changed cities during tumultuous times that taught me many lessons concerning mental health and productivity. I eventually graduated from BizSpark and outgrew the credit allotment. That killed the WordPress blog.
I blogged about writing again on the existing Blogger blog but it didn't feel right. I looked at a few options where I wouldn't have to worry about hosting cost indefinitely and Jekyll stood out with GitHub Pages. The Importer was fairly straightforward for the existing blog posts.
Todo * Set up redirects for all posts on blogger. The URI format is different so a complete redirect wouldn't work. Although, there may be something in Jekyll that could manage the redirects. I did notice the old URLs were stored in the front matter. I'm working on a command-line Ruby gem for the current plan. * I did find some of the lost WordPress posts on archive.org that I downloaded with the waybackmachinedownloader. I think I might write an importer for that. * I still have a few Disqus comment threads to map
Depends on what options and technologies you have available, and how do you deploy your website.
There are CMSs which update existing static pages through FTP: You provide access credentials, mark editable parts of your HTML in a markup, and then edit the content through the hosted CMS. I know two systems which work like that: Cushy CMS and Surreal CMS.
If the source of your site is versioned through Git (and hosted on GitHub), you have other options, like Netlify CMS, Spinal CMS, Siteleaf, Forestry, or CloudCannon. Some of these also need you to use static site generator (like 11ty, Jekyll, or Hugo).
If you have some server-side scripting support available (typically PHP) you can also consider some flat-file based, server-side systems, like Kirby CMS or Lektor, which are usually simpler to retrofit into an existing template than “traditional” CMSs (WordPress, Drupal).
Finally, you could also use a desktop-based static site generator which provides a user-friendly GUI, and then locally generates and uploads the website. For example Publii, YouDoCMS, Agit CMS.
- No config, easy to use2
- Maintained by React core team2
- No SSR1
related Create React App posts
I picked up an idea to develop and it was no brainer I had to go with React for the frontend. I was faced with challenges when it came to what component framework to use. I had worked extensively with Material-UI but I needed something different that would offer me wider range of well customized components (I became pretty slow at styling). I brought in Evergreen after several sampling and reads online but again, after several prototype development against Evergreen—since I was using TypeScript and I had to import custom Type, it felt exhaustive. After I validated Evergreen with the designs of the idea I was developing, I also noticed I might have to do a lot of styling. I later stumbled on Material Kit, the one specifically made for React . It was promising with beautifully crafted components, most of which fits into the designs pages I had on ground.
A major problem of Material Kit for me is it isn't written in TypeScript and there isn't any plans to support its TypeScript version. I rolled up my sleeve and started converting their components to TypeScript and if you'll ask me, I am still on it.
In summary, I used the Create React App with TypeScript support and I am spending some time converting Material Kit to TypeScript before I start developing against it. All of these components are going to be hosted on Bit.
If you feel I am crazy or I have gotten something wrong, I'll be willing to listen to your opinion. Also, if you want to have a share of whatever TypeScript version of Material Kit I end up coming up with, let me know.
I'm working as one of the engineering leads in RunaHR. As our platform is a Saas, we thought It'd be good to have an API (We chose Ruby and Rails for this) and a SPA (built with React and Redux ) connected. We started the SPA with Create React App since It's pretty easy to start.
We use Jest as the testing framework and react-testing-library to test React components. In Rails we make tests using RSpec.
Our main database is PostgreSQL, but we also use MongoDB to store some type of data. We started to use Redis for cache and other time sensitive operations.
We have a couple of extra projects: One is an Employee app built with React Native and the other is an internal back office dashboard built with Next.js for the client and Python in the backend side.
Since we have different frontend apps we have found useful to have Bit to document visual components and utils in JavaScript.
WordPress
- Customizable416
- Easy to manage367
- Plugins & themes354
- Non-tech colleagues can update website content259
- Really powerful247
- Rapid website development145
- Best documentation78
- Codex51
- Product feature set44
- Custom/internal social network35
- Open source18
- Great for all types of websites8
- Huge install and user base7
- I like it like I like a kick in the groin5
- It's simple and easy to use by any novice5
- Perfect example of user collaboration5
- Open Source Community5
- Most websites make use of it5
- Best5
- API-based CMS4
- Community4
- Easy To use3
- <a href="https://secure.wphackedhel">Easy Beginner</a>2
- Hard to keep up-to-date if you customize things13
- Plugins are of mixed quality13
- Not best backend UI10
- Complex Organization2
- Do not cover all the basics in the core1
- Great Security1
related WordPress posts
I've heard that I have the ability to write well, at times. When it flows, it flows. I decided to start blogging in 2013 on Blogger. I started a company and joined BizPark with the Microsoft Azure allotment. I created a WordPress blog and did a migration at some point. A lot happened in the time after that migration but I stopped coding and changed cities during tumultuous times that taught me many lessons concerning mental health and productivity. I eventually graduated from BizSpark and outgrew the credit allotment. That killed the WordPress blog.
I blogged about writing again on the existing Blogger blog but it didn't feel right. I looked at a few options where I wouldn't have to worry about hosting cost indefinitely and Jekyll stood out with GitHub Pages. The Importer was fairly straightforward for the existing blog posts.
Todo * Set up redirects for all posts on blogger. The URI format is different so a complete redirect wouldn't work. Although, there may be something in Jekyll that could manage the redirects. I did notice the old URLs were stored in the front matter. I'm working on a command-line Ruby gem for the current plan. * I did find some of the lost WordPress posts on archive.org that I downloaded with the waybackmachinedownloader. I think I might write an importer for that. * I still have a few Disqus comment threads to map
hello guys, I need your help. I created a website, I've been using Elementor forever, but yesterday I bought a template after I made the purchase I knew I made a mistake, cause the template was in HTML, can anyone please show me how to put this HTML template in my WordPress so it will be the face of my website, thank you in advance.
- Easy to use490
- Great tool369
- Makes developing rest api's easy peasy276
- Easy setup, looks good156
- The best api workflow out there144
- It's the best53
- History feature53
- Adds real value to my workflow44
- Great interface that magically predicts your needs43
- The best in class app35
- Can save and share script12
- Fully featured without looking cluttered10
- Collections8
- Option to run scrips8
- Global/Environment Variables8
- Shareable Collections7
- Dead simple and useful. Excellent7
- Dark theme easy on the eyes7
- Awesome customer support6
- Great integration with newman6
- Documentation5
- Simple5
- The test script is useful5
- Saves responses4
- This has simplified my testing significantly4
- Makes testing API's as easy as 1,2,34
- Easy as pie4
- API-network3
- I'd recommend it to everyone who works with apis3
- Mocking API calls with predefined response3
- Now supports GraphQL2
- Postman Runner CI Integration2
- Easy to setup, test and provides test storage2
- Continuous integration using newman2
- Pre-request Script and Test attributes are invaluable2
- Runner2
- Graph2
- <a href="http://fixbit.com/">useful tool</a>1
- Stores credentials in HTTP10
- Bloated features and UI9
- Cumbersome to switch authentication tokens8
- Poor GraphQL support7
- Expensive5
- Not free after 5 users3
- Can't prompt for per-request variables3
- Import swagger1
- Support websocket1
- Import curl1
related Postman posts
We just launched the Segment Config API (try it out for yourself here) — a set of public REST APIs that enable you to manage your Segment configuration. A public API is only as good as its #documentation. For the API reference doc we are using Postman.
Postman is an “API development environment”. You download the desktop app, and build API requests by URL and payload. Over time you can build up a set of requests and organize them into a “Postman Collection”. You can generalize a collection with “collection variables”. This allows you to parameterize things like username
, password
and workspace_name
so a user can fill their own values in before making an API call. This makes it possible to use Postman for one-off API tasks instead of writing code.
Then you can add Markdown content to the entire collection, a folder of related methods, and/or every API method to explain how the APIs work. You can publish a collection and easily share it with a URL.
This turns Postman from a personal #API utility to full-blown public interactive API documentation. The result is a great looking web page with all the API calls, docs and sample requests and responses in one place. Check out the results here.
Postman’s powers don’t end here. You can automate Postman with “test scripts” and have it periodically run a collection scripts as “monitors”. We now have #QA around all the APIs in public docs to make sure they are always correct
Along the way we tried other techniques for documenting APIs like ReadMe.io or Swagger UI. These required a lot of effort to customize.
Writing and maintaining a Postman collection takes some work, but the resulting documentation site, interactivity and API testing tools are well worth it.
Our whole Node.js backend stack consists of the following tools:
- Lerna as a tool for multi package and multi repository management
- npm as package manager
- NestJS as Node.js framework
- TypeScript as programming language
- ExpressJS as web server
- Swagger UI for visualizing and interacting with the API’s resources
- Postman as a tool for API development
- TypeORM as object relational mapping layer
- JSON Web Token for access token management
The main reason we have chosen Node.js over PHP is related to the following artifacts:
- Made for the web and widely in use: Node.js is a software platform for developing server-side network services. Well-known projects that rely on Node.js include the blogging software Ghost, the project management tool Trello and the operating system WebOS. Node.js requires the JavaScript runtime environment V8, which was specially developed by Google for the popular Chrome browser. This guarantees a very resource-saving architecture, which qualifies Node.js especially for the operation of a web server. Ryan Dahl, the developer of Node.js, released the first stable version on May 27, 2009. He developed Node.js out of dissatisfaction with the possibilities that JavaScript offered at the time. The basic functionality of Node.js has been mapped with JavaScript since the first version, which can be expanded with a large number of different modules. The current package managers (npm or Yarn) for Node.js know more than 1,000,000 of these modules.
- Fast server-side solutions: Node.js adopts the JavaScript "event-loop" to create non-blocking I/O applications that conveniently serve simultaneous events. With the standard available asynchronous processing within JavaScript/TypeScript, highly scalable, server-side solutions can be realized. The efficient use of the CPU and the RAM is maximized and more simultaneous requests can be processed than with conventional multi-thread servers.
- A language along the entire stack: Widely used frameworks such as React or AngularJS or Vue.js, which we prefer, are written in JavaScript/TypeScript. If Node.js is now used on the server side, you can use all the advantages of a uniform script language throughout the entire application development. The same language in the back- and frontend simplifies the maintenance of the application and also the coordination within the development team.
- Flexibility: Node.js sets very few strict dependencies, rules and guidelines and thus grants a high degree of flexibility in application development. There are no strict conventions so that the appropriate architecture, design structures, modules and features can be freely selected for the development.
- Easy to use490
- Great tool369
- Makes developing rest api's easy peasy276
- Easy setup, looks good156
- The best api workflow out there144
- It's the best53
- History feature53
- Adds real value to my workflow44
- Great interface that magically predicts your needs43
- The best in class app35
- Can save and share script12
- Fully featured without looking cluttered10
- Collections8
- Option to run scrips8
- Global/Environment Variables8
- Shareable Collections7
- Dead simple and useful. Excellent7
- Dark theme easy on the eyes7
- Awesome customer support6
- Great integration with newman6
- Documentation5
- Simple5
- The test script is useful5
- Saves responses4
- This has simplified my testing significantly4
- Makes testing API's as easy as 1,2,34
- Easy as pie4
- API-network3
- I'd recommend it to everyone who works with apis3
- Mocking API calls with predefined response3
- Now supports GraphQL2
- Postman Runner CI Integration2
- Easy to setup, test and provides test storage2
- Continuous integration using newman2
- Pre-request Script and Test attributes are invaluable2
- Runner2
- Graph2
- <a href="http://fixbit.com/">useful tool</a>1
- Stores credentials in HTTP10
- Bloated features and UI9
- Cumbersome to switch authentication tokens8
- Poor GraphQL support7
- Expensive5
- Not free after 5 users3
- Can't prompt for per-request variables3
- Import swagger1
- Support websocket1
- Import curl1
related Postman posts
We just launched the Segment Config API (try it out for yourself here) — a set of public REST APIs that enable you to manage your Segment configuration. A public API is only as good as its #documentation. For the API reference doc we are using Postman.
Postman is an “API development environment”. You download the desktop app, and build API requests by URL and payload. Over time you can build up a set of requests and organize them into a “Postman Collection”. You can generalize a collection with “collection variables”. This allows you to parameterize things like username
, password
and workspace_name
so a user can fill their own values in before making an API call. This makes it possible to use Postman for one-off API tasks instead of writing code.
Then you can add Markdown content to the entire collection, a folder of related methods, and/or every API method to explain how the APIs work. You can publish a collection and easily share it with a URL.
This turns Postman from a personal #API utility to full-blown public interactive API documentation. The result is a great looking web page with all the API calls, docs and sample requests and responses in one place. Check out the results here.
Postman’s powers don’t end here. You can automate Postman with “test scripts” and have it periodically run a collection scripts as “monitors”. We now have #QA around all the APIs in public docs to make sure they are always correct
Along the way we tried other techniques for documenting APIs like ReadMe.io or Swagger UI. These required a lot of effort to customize.
Writing and maintaining a Postman collection takes some work, but the resulting documentation site, interactivity and API testing tools are well worth it.
Our whole Node.js backend stack consists of the following tools:
- Lerna as a tool for multi package and multi repository management
- npm as package manager
- NestJS as Node.js framework
- TypeScript as programming language
- ExpressJS as web server
- Swagger UI for visualizing and interacting with the API’s resources
- Postman as a tool for API development
- TypeORM as object relational mapping layer
- JSON Web Token for access token management
The main reason we have chosen Node.js over PHP is related to the following artifacts:
- Made for the web and widely in use: Node.js is a software platform for developing server-side network services. Well-known projects that rely on Node.js include the blogging software Ghost, the project management tool Trello and the operating system WebOS. Node.js requires the JavaScript runtime environment V8, which was specially developed by Google for the popular Chrome browser. This guarantees a very resource-saving architecture, which qualifies Node.js especially for the operation of a web server. Ryan Dahl, the developer of Node.js, released the first stable version on May 27, 2009. He developed Node.js out of dissatisfaction with the possibilities that JavaScript offered at the time. The basic functionality of Node.js has been mapped with JavaScript since the first version, which can be expanded with a large number of different modules. The current package managers (npm or Yarn) for Node.js know more than 1,000,000 of these modules.
- Fast server-side solutions: Node.js adopts the JavaScript "event-loop" to create non-blocking I/O applications that conveniently serve simultaneous events. With the standard available asynchronous processing within JavaScript/TypeScript, highly scalable, server-side solutions can be realized. The efficient use of the CPU and the RAM is maximized and more simultaneous requests can be processed than with conventional multi-thread servers.
- A language along the entire stack: Widely used frameworks such as React or AngularJS or Vue.js, which we prefer, are written in JavaScript/TypeScript. If Node.js is now used on the server side, you can use all the advantages of a uniform script language throughout the entire application development. The same language in the back- and frontend simplifies the maintenance of the application and also the coordination within the development team.
- Flexibility: Node.js sets very few strict dependencies, rules and guidelines and thus grants a high degree of flexibility in application development. There are no strict conventions so that the appropriate architecture, design structures, modules and features can be freely selected for the development.