@digdir/dialogporten-schema 1.0.11 → 1.7.1-576560d
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Dialogporten Schema Package
|
|
2
|
+
|
|
3
|
+
This npm package contains both the Swagger and GraphQL schema definitions for the Dialogporten API. It is designed to provide developers with the necessary specifications to interact with the Dialogporten API effectively.
|
|
4
|
+
|
|
5
|
+
## Description
|
|
6
|
+
This package includes:
|
|
7
|
+
- **GraphQL Schema (schema.verified.graphql)**: Defines the types, queries, and mutations available in the Dialogporten GraphQL API.
|
|
8
|
+
- **OpenAPI Specification ((swagger.verified.json))**: Provides a detailed description of the RESTful endpoints, parameters, and models used in the Dialogporten API.
|
|
9
|
+
|
|
10
|
+
## Usage
|
|
11
|
+
To use this package, include it in your project dependencies using npm:
|
|
12
|
+
To install the Dialogporten Schema Package in your JavaScript project, follow these steps:
|
|
13
|
+
|
|
14
|
+
1. Ensure you have npm installed. You can check by running `npm -v` in your terminal. If npm is not installed, download and install Node.js from [nodejs.org](https://nodejs.org/), which includes npm.
|
|
15
|
+
|
|
16
|
+
2. Add the Dialogporten Schema Package to your project dependencies. Run the following command in your project directory:
|
|
17
|
+
```bash
|
|
18
|
+
npm install @digdir/dialogporten-schema
|
|
19
|
+
```
|