Code #565

fsamwel · 2020-07-02T11:44:57Z

Op basis van actuele API specificaties gegenereerd:

client SDK's voor dotnet, java en python
resolved specificaties (genereervariant)
overzicht van testgevallen en testcoverage
postman collection

Inclusief de gebruikte scripts voor het genereren.

JohanBoer

Ik heb hier onvoldoende kennis van om goed te kunnen reviewen. Ik heb een paar opmerkingen geplaatst van wat mij opviel toen ik het doorkeek.

JohanBoer · 2020-07-02T12:34:38Z

code/csharp-dotnet2/README.md

+
+This C# SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 1.0.0


Moet dit niet versie 1.1.0 worden ? We brengen deze SDK's toch samen met de versie 1.1.0 van BRK-bevragingen uit ?

dit heb je zelf al opgelost zie ik in pull request #566

Dat klopt, maar dan is het hier toch nog niet opgelost? Of wordt dit allemaal opnieuw gegenereerd op het moment dat we een release aanmaken ?

ja, na elke wijziging van de specificaties kan (naar mijn idee: moet) iemand dit opnieuw genereren. Dan hebben we direct een consistente set van:

api specificaties

resolved specificaties

client SDK

overzicht testdata

Postman collection

Dat is precies waarom ik dit gemaakt heb, we hebben nog een heel oud Postman collection bestand staan, oude Excel sheet met wat ooit de testdata was, de genereerversie van de specificatie was maar gedeeltelijk bijgewerkt. Toch jammer wanneer het in die toestand een release was geworden.

JohanBoer · 2020-07-02T12:49:25Z

code/csharp-dotnet2/docs/Aantekening.md

+**EinddatumRecht** | **DateTime?** |  | [optional] 
+**IndicatieOorspronkelijkObject** | **bool?** |  | [optional] 
+**BetreftGedeelteVanPerceel** | **bool?** |  | [optional] 
+


Het valt me hier op dat de Namen van de properties met een hoofdletter beginnen terwijl dit in de specifcatie camelCase is. Ik weet niet of dat er toe doet. Dit geldt voor alle componenten.

Dat doet de code generator. @MelvLee is dat normaal voor schaap/dotnet?

Mijn vermoeden is dat dit gebruikelijke naamgeving is in C#

Hier: string, bool, float en andere basistypes

Hier: DateTime

Dat doet de code generator. @MelvLee is dat normaal voor schaap/dotnet?

Ja, in C# worden verschillende capitalization conventions gebruikt. In het kort pascal casing voor class en property namen en camel case voor parameter namen

JohanBoer · 2020-07-02T12:58:24Z

code/csharp-dotnet2/docs/Datum_onvolledig.md

+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Dag** | **int?** | De dag. Als de dag van de datum bekend is wordt deze hier ingevuld. Ook als de volledige datum bekend is. | [optional] 
+**Datum** | **DateTime?** | De volledige datum die in de &#x60;date&#x60; definitie past. Dit element wordt alleen gevuld als de volledige datum bekend is. | [optional] 


Datum is in de specificatie "date"geen datetime. Dit komt overal voor waar een "date " is gespecificeerd in de OAS3. Ik neem aan dat dat te maken heeft met hoe je datums in csharp definieert.

Dat denk ik ook (C# DateTime definitie). Vergelijkbaar met de DateTime vanaf Java 8.

JohanBoer · 2020-07-02T13:00:05Z

code/csharp-dotnet2/docs/Geslacht_enum.md

@@ -0,0 +1,8 @@
+# IO.Swagger.Model.GeslachtEnum
+## Properties
+


Hoeven de waarden van een enumeratie niet gedfinieerd te worden ?

Dit is geen code file, maar een markdown file. En een enum kent geen properties. Daarom is de file leeg

code/java/src/main/java/io/swagger/client/model/ZakelijkGerechtigdeHal.java

fsamwel · 2020-07-02T15:22:11Z

@MelvLee zou jij eens willen kijken naar de nu gegenereerde dotnet code. Is die goed, of moeten we hier een andere generator gebruiken?
openapi-generator heeft ook verschillende csharp generatoren:

csharp
csharp-dotnet2 (deprecated)
csharp-netcore

rhengeveld · 2020-07-02T16:04:02Z

code/java/README.md

 - [BadRequestFoutbericht](docs/BadRequestFoutbericht.md)
+ - [BadRequestFoutberichtAllOf](docs/BadRequestFoutberichtAllOf.md)


Dit ziet er vreemd uit - klopt dit met de AllOf erin? Misschien dat deze generator toch ander gedrag heeft.

Ik kwam dit trouwens in je eerste Java update commit tegen. GitHub zegt dat dit nu 'outdated' is, maar ik kan niet goed zien met zoveel wijzigingen of dit nog steeds van toepassing is of niet.

rhengeveld · 2020-07-02T16:05:33Z

code/java/README.md

-  <groupId>io.swagger</groupId>
-  <artifactId>swagger-java-client</artifactId>
+  <groupId>org.openapitools</groupId>
+  <artifactId>openapi-java-client</artifactId>
  <version>1.0.0</version>


Hoort dit niet <version>4.3.0</version> te zijn?
Volgens mij is dit de release pagina, anders haal ik dingen door elkaar (naamgeving van die tools is ambigu) 🤔

rhengeveld · 2020-07-02T16:06:37Z

code/java/build.gradle

-            sourceCompatibility JavaVersion.VERSION_1_7
-            targetCompatibility JavaVersion.VERSION_1_7
+            sourceCompatibility JavaVersion.VERSION_1_8
+            targetCompatibility JavaVersion.VERSION_1_8


MelvLee · 2020-07-03T10:10:02Z

@MelvLee zou jij eens willen kijken naar de nu gegenereerde dotnet code. Is die goed, of moeten we hier een andere generator gebruiken?
openapi-generator heeft ook verschillende csharp generatoren:
* csharp

* csharp-dotnet2 (deprecated)

* csharp-netcore

Ik kan het moeilijk beoordelen vanuit de PR. Het zijn teveel bestanden. Ik heb daarom de code zelf gegenereerd met de tool. De gegenereerde code kan ik compileren. Ik heb alleen een maar. Met de default settings genereert de generator een complete solution, inclusief een test project. Er is dus meer code gegenereerd dan alleen code om de api te bevragen. Het is daardoor minder bruikbaar voor een bestaand project. Ik zal nog even kijken of het mogelijk is om alleen de benodigde code te genereren

MelvLee · 2020-07-07T14:11:01Z

Het is mogelijk via settings alleen de benodigde client code te genereren.
Voor .NET Core ziet het er als volgt uit: npx @openapitools/openapi-generator-cli generate -i openapi.yaml -g csharp-netcore --global-property=modelTests=false,apiTests=false,modelDocs=false,apiDocs=false --additional-properties=optionalProjectFile=false,optionalAssemblyInfo=false.
Voor .NET Full Framework ziet het er als volgt uit: npx @openapitools/openapi-generator-cli generate -i openapi.yaml -g csharp --global-property=modelTests=false,apiTests=false,modelDocs=false,apiDocs=false --additional-properties=optionalProjectFile=false,optionalAssemblyInfo=false.

csharp-dotnet2 is deprecated. Daarvoor zou ik geen code genereren.

De output map waar de code terecht moet komen is niet toegevoegd in bovenstaande settings

…eltests worden meegegenereerd. Plus meegenereren testcases.

fsamwel added 2 commits July 2, 2020 13:33

genereren van client SDK, resolved OAS, testdata en Postman project

7114381

getting started met verwijzing naar gegenereerde Postman collextion

218d1e7

fsamwel requested review from JohanBoer and MelvLee July 2, 2020 11:44

JohanBoer reviewed Jul 2, 2020

View reviewed changes

rhengeveld reviewed Jul 2, 2020

View reviewed changes

code/java/src/main/java/io/swagger/client/model/ZakelijkGerechtigdeHal.java Outdated Show resolved Hide resolved

fsamwel added 2 commits July 2, 2020 17:38

java client gegeneerd met openapi-generator

90e6057

generator aangepast voor java client

83098ed

rhengeveld reviewed Jul 2, 2020

View reviewed changes

fsamwel added 2 commits July 7, 2020 17:49

gebruik andere generator voor csharp en java waarbij geen docs en mod…

5717a24

…eltests worden meegegenereerd. Plus meegenereren testcases.

ook beperktere gegenereerde code (geen documentatie) voor java en python

d88ff6f

MelvLee approved these changes Jul 8, 2020

View reviewed changes

fsamwel merged commit 93d311a into VNG-Realisatie:master Jul 9, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Code #565

Code #565

fsamwel commented Jul 2, 2020

JohanBoer left a comment

JohanBoer Jul 2, 2020

fsamwel Jul 2, 2020

JohanBoer Jul 2, 2020

fsamwel Jul 2, 2020

JohanBoer Jul 2, 2020

fsamwel Jul 2, 2020

rhengeveld Jul 2, 2020 •

edited

Loading

MelvLee Jul 3, 2020

JohanBoer Jul 2, 2020

rhengeveld Jul 2, 2020 •

edited

Loading

JohanBoer Jul 2, 2020

MelvLee Jul 3, 2020

fsamwel commented Jul 2, 2020

rhengeveld Jul 2, 2020

rhengeveld Jul 2, 2020

rhengeveld Jul 2, 2020 •

edited

Loading

rhengeveld Jul 2, 2020

MelvLee commented Jul 3, 2020

MelvLee commented Jul 7, 2020


		This C# SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

		- API version: 1.0.0

		- [BadRequestFoutbericht](docs/BadRequestFoutbericht.md)
		- [BadRequestFoutberichtAllOf](docs/BadRequestFoutberichtAllOf.md)

Code #565

Code #565

Conversation

fsamwel commented Jul 2, 2020

JohanBoer left a 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

rhengeveld Jul 2, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rhengeveld Jul 2, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fsamwel commented Jul 2, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rhengeveld Jul 2, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MelvLee commented Jul 3, 2020

MelvLee commented Jul 7, 2020

rhengeveld Jul 2, 2020 •

edited

Loading

rhengeveld Jul 2, 2020 •

edited

Loading

rhengeveld Jul 2, 2020 •

edited

Loading