Skip to main content

Main configuration file

What is it?​

NgOP's main configuration file is an optional file where you can influence some of the NgOP's functionality.

How to name it and where to place it?​

If you will decide (or need to) create it it has to be called ngop.json and be placed in the root directory of your Angular application (there where angular.json file is defined).

Content type​

As you may have noticed this file' contents need to be in JSON format.

Properties​

  • ignoreProjects / string[] / optional

List of your Angular projects that should not be parsed by NgOP.

  • serverApis / string[] / optional

List of paths to your API definition files. Currently supports only local files (by relative paths) and no URLs.

Example​

{
  "ignoreProjects": [],
  "serverApis": [
    "./api/test-api.yaml"
  ]
}