Swagger Faker

What is Swagger Faker?

Swagger Faker generates fake data from a swagger.json file and automatically starts a mock server with that generated fake data. It is designed for developers who need quick mock APIs based on OpenAPI specifications.

How to use Swagger Faker?

Install it globally via npm i swagger-faker -g. Run swagger-faker init to create a configuration file, update it with your swagger source paths, then run swagger-faker gen to generate mock data and swagger-faker run to start the mock server.

Key features of Swagger Faker

• Generates fake data from swagger/openapi JSON specifications.
• Automatically starts a mock server on a configurable port.
• Configurable output folder, timeout, and port.
• Generated mock data is stored locally and is customizable.

Use cases of Swagger Faker

• Quickly mock REST APIs during frontend development.
• Test application behavior with realistic fake data.
• Create mock servers for demos or prototypes without a real backend.

FAQ from Swagger Faker

What runtime is required?

Node.js and npm are required for installation (npm i swagger-faker -g).

How can I customize the mock data?

After running swagger-faker gen, the mock data files are placed in the mock-server/data folder. You can edit these JSON files directly to customize the responses.

What port does the mock server use by default?

The default port is 8081, but you can change it by setting the port field in the swagger-faker.config.json file.

How do I specify which OpenAPI file to use?

In the configuration file, set the sourcePaths array to the path of your swagger or OpenAPI file (e.g., "./source/openapi.json").