You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+67Lines changed: 67 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -108,6 +108,73 @@ npm start -- -f openapi.yaml
108
108
```
109
109
> Notera: Att alla kommandon lokalt körs med `npm start --`.
110
110
111
+
### API (Application programming interface) läge
112
+
```bash
113
+
npm start -- -m api
114
+
```
115
+
116
+
Validera mot en endpoint:
117
+
```bash
118
+
POST http://localhost:3000/api/v1/validation/validate
119
+
```
120
+
121
+
Request body - application/json`
122
+
```bash
123
+
{
124
+
"yaml": "<base64encoded file>",
125
+
"categories": [
126
+
"CATEGORY1",
127
+
"CATEGORY2"
128
+
]
129
+
}
130
+
```
131
+
132
+
Använd detta kommando för att validera en yaml-fil via terminalen, här kan du även validera mot specifika [kategorier](#tillgängliga-kategorier-med-regler):
133
+
```bash
134
+
curl -X POST http://localhost:3000/api/v1/validation/validate \
Det går också att validera via en url istället för en fil men då behöver API-läget startas med en extra flagga för att låsa upp möjligheten att nyttja endpointen:
146
+
```bash
147
+
npm start -- -m api --enableUrlValidation
148
+
```
149
+
150
+
Använd detta kommando för att validera en yaml-fil baserat på en url via terminalen, även här kan man skicka med kategorier för valideringen. Se tidigare kommando:
151
+
```bash
152
+
curl -sS -X POST http://localhost:3000/api/v1/validation/url \
153
+
-H "Content-Type: application/json" \
154
+
-d '{"url":"<URL_TO_YAML_FILE>"}'| jq
155
+
```
156
+
157
+
Exempel:
158
+
```bash
159
+
curl -sS -X POST http://localhost:3000/api/v1/validation/url \
160
+
-H "Content-Type: application/json" \
161
+
-d '{"url":"https://testurl.com/q/openapi"}'| jq
162
+
```
163
+
164
+
#### Ladda ned information om regelutfall som en Excel-fil via api-läge
165
+
166
+
För att spara information om regelutfall från diagnostiseringen till en avstämningsfil i Excel, använd resultatet från tidigare validering som "result" nedan:
167
+
```bash
168
+
curl -X POST http://localhost:5173/api/validation/generate-report \
169
+
-H "Content-Type: application/json" \
170
+
-o avstamningsfil.xlsx \
171
+
-d '{
172
+
"result": [],
173
+
"categories": []
174
+
}'
175
+
176
+
```
177
+
111
178
## Versioner
112
179
Main-branchen, feature-brancher, pre-release- och testversioner används med reservation för att de kan innehålla funktionalitet som inte är garanterad att den är testad på samma sätt som en stabil version.
0 commit comments