feat: create kennisbank-api server #912

AliKdhim87 · 2024-10-01T14:53:53Z

No description provided.

vercel · 2024-10-01T14:53:57Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
cms-frameless-io	❌ Failed (Inspect)			Oct 25, 2024 10:55am
tiptap	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 25, 2024 10:55am

codecov · 2024-10-01T15:02:53Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Robbert · 2024-10-24T07:23:45Z

apps/overige-object-api/README.md

+After generating the token, include it in your request headers as a Bearer token. Here's an example:
+
+```ts
+Authorization: Bearer API_TOKEN


Suggested change

Authorization: Bearer API_TOKEN

Authorization: Token API_TOKEN

Robbert · 2024-10-24T07:24:24Z

apps/overige-object-api/README.md

+
+```shell
+OVERIGE_OBJECT_API_PORT=4001
+OVERIGE_OBJECT_API_CORS=http://localhost:3000 # If using multiple domains, separate them with a comma (e.g., 'http://localhost:3000, http://localhost:3001').


De # comment aan het eind van de regel, die kan gewoon voor het code block in de lopende tekst.

Robbert · 2024-10-24T07:24:43Z

apps/overige-object-api/README.md

+To start the service, open a terminal in the project root and run:
+
+```shell
+cd bin && bash ./deploy.sh pdc-dashboard prod up --build


Op deze manier hoef je niet achteraf cd .. te doen, en kun je het command meerdere keren achter elkaar draaien zonder extra commands.

Suggested change

cd bin && bash ./deploy.sh pdc-dashboard prod up --build

( cd bin && bash ./deploy.sh pdc-dashboard prod up --build )

Robbert · 2024-10-24T07:27:54Z

apps/overige-object-api/package.json

+    "url": "[email protected]:frameless/strapi.git",
+    "directory": "apps/overige-object-api"
+  }
+}


In de toekomst is het misschien leuk om twee versies te hebben van de Overige Objecten API:

Strapi als bron. Optioneel, bijvoorbeeld met npm run start --strapi https://strapi.localhost:1337/"

Filesystem als bron. Bijvoorbeeld npm run start --object-dir objects/ --object-types-dir object-types/

Utility functions om dit te maken zouden ook handig zijn voor tests. Bijvoorbeeld:

let server; beforeEach(() => { server = serverFromFileSystem({ objectDir: 'fixtures/scenario-5/objects', objectDir: 'fixtures/scenario-5/objects-types', }); });

Robbert · 2024-10-24T07:30:55Z

apps/overige-object-api/src/__mocks__/objectsResponseData.ts

+        doelgroep: 'eu-burger',
+      },
+    ],
+  };


Ik zou het netter vinden om de const data buiten de functie te plaatsen.

Robbert · 2024-10-24T07:41:00Z

apps/overige-object-api/src/utils/fetchData.ts

+ */
+const handleGraphqlError = (error: any) => {
+  const errorMessage = error?.message || 'GraphQL error';
+  const errorCode = error?.extensions?.code || 400; // Handle extensions (specific to GraphQL)


Is 500 niet logischer als default?

HTTP 500 De server snapt het zelf ook niet helemaal meer 😉

Robbert · 2024-10-24T07:41:19Z

apps/overige-object-api/src/utils/fetchData.ts

+const handleHttpError = (response: Response) => {
+  const status = response.status;
+
+  let errorMessage = response.statusText || 'Unknown error';


Unknown error is geen status. Doe dan status 500.

Robbert · 2024-10-24T07:43:07Z

apps/overige-object-api/src/utils/fetchData.ts

+    // Handle GraphQL-specific errors
+    if (data.errors && data.errors.length > 0) {
+      data.errors.forEach(handleGraphqlError); // Process each error
+    }


De volgende comments zijn echt heel erg stating the obvious, wat mij betreft kunnen ze weg.

// Default to an empty object if no headers are provided

// Check for non-successful responses (status not in the 2xx range)

// Process each error

Robbert · 2024-10-24T07:43:53Z

apps/overige-object-api/src/server.ts

+ * This is only available in development mode
+ */
+if (process.env.NODE_ENV === 'development') {
+  app.use('/api/v1/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));


kan dit niet beter gewoon onder /swagger/?

Robbert · 2024-10-24T07:45:20Z

apps/overige-object-api/src/server.ts

+});
+
+const swaggerDocument: any = yaml.load(fs.readFileSync(path.join(__dirname, './docs/openapi.yaml'), 'utf8'));
+const whitelist = process.env.OVERIGE_OBJECT_API_CORS?.split(', ') || [];


Op deze manier weet typescript beter dat het een string[] is.

Suggested change

const whitelist = process.env.OVERIGE_OBJECT_API_CORS?.split(', ') || [];

const whitelist = (process.env.OVERIGE_OBJECT_API_CORS || '').split(', ');

The reason for reverting the component specifications to YAML, instead of referencing the JSON files, is that this approach did not work well with Swagger UI. This issue would also affect the openapi.json if integrated with Swagger UI.

vercel bot had a problem deploying to Preview – cms-frameless-io October 1, 2024 14:56 Failure

AliKdhim87 force-pushed the kennisbank-api branch from 4283914 to 62f2cbf Compare October 1, 2024 14:56

vercel bot deployed to Preview – tiptap October 1, 2024 14:57 View deployment

vercel bot had a problem deploying to Preview – cms-frameless-io October 1, 2024 14:59 Failure

This was linked to issues Oct 2, 2024

Create kennisbank-api #915

Closed

API-validatie toevoegen aan kennisbank server #916

Closed

vercel bot had a problem deploying to Preview – cms-frameless-io October 2, 2024 15:05 Failure

vercel bot deployed to Preview – tiptap October 2, 2024 15:05 View deployment

AliKdhim87 force-pushed the kennisbank-api branch from 3bb8a9c to eed2de4 Compare October 3, 2024 15:02

vercel bot deployed to Preview – tiptap October 3, 2024 15:02 View deployment

vercel bot had a problem deploying to Preview – cms-frameless-io October 3, 2024 15:05 Failure

This was linked to issues Oct 3, 2024

Genereer API-interface types voor Kennisartikel & VAC #922

Closed

Genereer TypeScript-interfaces op basis van Kennisartikel- en VAC-schema's #918

Closed

Implementeren van CORS (Cross-origin resource sharing) #921

Closed

AliKdhim87 force-pushed the kennisbank-api branch from eed2de4 to 8ee49b2 Compare October 4, 2024 12:32

vercel bot deployed to Preview – tiptap October 4, 2024 12:32 View deployment

vercel bot had a problem deploying to Preview – cms-frameless-io October 4, 2024 12:35 Failure

AliKdhim87 linked an issue Oct 4, 2024 that may be closed by this pull request

Valideer elke kennisbank-api verzoek met kennisartikel- en VAC schema's #923

Closed

AliKdhim87 force-pushed the kennisbank-api branch from 8ee49b2 to fee9af1 Compare October 4, 2024 14:05

vercel bot deployed to Preview – tiptap October 4, 2024 14:05 View deployment

vercel bot had a problem deploying to Preview – cms-frameless-io October 4, 2024 14:07 Failure

AliKdhim87 force-pushed the kennisbank-api branch from fee9af1 to 9e528a7 Compare October 4, 2024 14:11

vercel bot had a problem deploying to Preview – cms-frameless-io October 4, 2024 14:13 Failure

AliKdhim87 requested a review from Robbert October 4, 2024 14:13

vercel bot deployed to Preview – tiptap October 4, 2024 14:13 View deployment

AliKdhim87 force-pushed the kennisbank-api branch from 9e528a7 to e996af8 Compare October 4, 2024 14:23

vercel bot deployed to Preview – tiptap October 4, 2024 14:23 View deployment

AliKdhim87 force-pushed the kennisbank-api branch from e996af8 to fa92053 Compare October 4, 2024 14:23

AliKdhim87 added 3 commits October 23, 2024 12:20

feat: implement openapi specification

6db86fb

feat: generate API interface types for kennisartikel & vac

2120f3b

feat: add express-openapi-validator

5166ae6

AliKdhim87 force-pushed the kennisbank-api branch from 0fa2dc6 to 905f23d Compare October 23, 2024 10:44

vercel bot had a problem deploying to Preview – cms-frameless-io October 23, 2024 10:46 Failure

vercel bot deployed to Preview – tiptap October 23, 2024 10:46 View deployment

Robbert reviewed Oct 24, 2024

View reviewed changes

vercel bot deployed to Preview – tiptap October 24, 2024 12:38 View deployment

vercel bot had a problem deploying to Preview – cms-frameless-io October 24, 2024 12:40 Failure

AliKdhim87 added 15 commits October 25, 2024 12:44

docs: update the strapi.frameless website with kennisbank-api

72c56db

docs: update root README with kennisbank-api

e232a0b

docs: add README file

b061cb9

feat: integrate swagger-ui-express

aeaae4e

feat: implement objecttypes routers for kennisartikel & VAC

5ac6b84

refactor: refactor kennisbank-api server

7d41c5c

feat: integrate kennisartikelMetadata collection into kennisbank-api

796e229

feat(pdc-dashboard): create kennisartikelMetadata

4f7b965

test: integrate jest into kennisbank-api

39a7651

refactor: revert the openapi.yaml

d22a885

The reason for reverting the component specifications to YAML, instead of referencing the JSON files, is that this approach did not work well with Swagger UI. This issue would also affect the openapi.json if integrated with Swagger UI.

refactor: inject API token into request headers

c1e6d7c

refactor: refactor API_TOKEN from Bearer to TOKEN

8d89699

refactor: rename the kennisbank-api to overige-object-api

f68e6cf

feat: implement pagination

7328470

refactor: rename overige-object-api to overige-objecten-api

125f9f2

AliKdhim87 force-pushed the kennisbank-api branch from 968b2b8 to 125f9f2 Compare October 25, 2024 10:52

vercel bot had a problem deploying to Preview – cms-frameless-io October 25, 2024 10:55 Failure

vercel bot deployed to Preview – tiptap October 25, 2024 10:55 View deployment

Robbert approved these changes Oct 25, 2024

View reviewed changes

Robbert merged commit aea8d46 into main Oct 25, 2024
7 of 8 checks passed

Robbert deleted the kennisbank-api branch October 25, 2024 11:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: create kennisbank-api server #912

feat: create kennisbank-api server #912

AliKdhim87 commented Oct 1, 2024

vercel bot commented Oct 1, 2024 •

edited

Loading

codecov bot commented Oct 1, 2024 •

edited

Loading

Robbert Oct 24, 2024

Robbert Oct 24, 2024

Robbert Oct 24, 2024

Robbert Oct 24, 2024

Robbert Oct 24, 2024

Robbert Oct 24, 2024

Robbert Oct 24, 2024

Robbert Oct 24, 2024

Robbert Oct 24, 2024

Robbert Oct 24, 2024

	Authorization: Bearer API_TOKEN
	Authorization: Token API_TOKEN

	cd bin && bash ./deploy.sh pdc-dashboard prod up --build
	( cd bin && bash ./deploy.sh pdc-dashboard prod up --build )

	const whitelist = process.env.OVERIGE_OBJECT_API_CORS?.split(', ') \|\| [];
	const whitelist = (process.env.OVERIGE_OBJECT_API_CORS \|\| '').split(', ');

feat: create kennisbank-api server #912

feat: create kennisbank-api server #912

Conversation

AliKdhim87 commented Oct 1, 2024

vercel bot commented Oct 1, 2024 • edited Loading

codecov bot commented Oct 1, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vercel bot commented Oct 1, 2024 •

edited

Loading

codecov bot commented Oct 1, 2024 •

edited

Loading