Microsoft 365 Community Microsoft Graph, 5 Apr 2022

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: The future of self-serve Microsoft Graph SDKs

Description

In this 14-minute developer focused demo – Rabeb Othmani delivers a preview on Kiota, the OpenAPI based code generator for creating SDKs with selected APIs, including your own. Step through the streamlined SDK generation process - create and export a postman collection from Graph Explorer, use Hidi to slice (transform) the Graph OpenAPI doc using the Postman collection as filter, and deliver the reduced size output doc from Hidi to Kiota that generates the .NET SDK. This PnP Community demo is taken from the weekly Microsoft 365 Platform Community call recorded on April 5, 2022.

Demo Presenter
• Rabeb Othmani (Microsoft) | @Rabeb_Othmani

Supporting materials
• Repo – Project Kiota | https://github.com/microsoft/kiota/
• Article - Welcome to Kiota | https://microsoft.github.io/kiota/
• Tool – nuget Microsoft.OpenApi.Hidi | https://www.nuget.org/packages/Microsoft.OpenApi.Hidi
• Tool – Graph Explorer | aka.ms/ge
• Tool – Microsoft Graph | aka.ms/graph

Learn more
• Learn more about the Microsoft 365 Patterns and Practices community at: http://aka.ms/m365pnp
• Visit the Microsoft 365 Patterns and Practices community YouTube channel: https://aka.ms/m365pnp/videos

A

I'm gonna very quickly start with some few slides. I know we have too many demos, so um I'm gonna be as quick as possible here, uh hello, everyone, my name is rabb and I am a senior pm with the microsoft graph team. I'm super excited to be here today, because I actually have a few new things that I want to share with you and also it's great to show how different of our tools are coming together very nicely. So everything is like working together.

A

It's like pieces of one puzzle and I'm gonna be showing you how everything is uh working together, but um first of all just a little bit of context to how we are where we are today. um As microsoft graph been evolving and as we keep adding new features, it became very apparent for us that we are having few challenges uh generating our sdks. It was taking too long to support new languages or adding any new features from microsoft graph and the tech stack that we were using were fairly painful.

A

We we made few promises to you, we made through promises to the community and then either we couldn't keep our promises or it was way too long to deliver. Simply because of these challenges we thought autorest would solve the issues for us, but unfortunately, autorest did not scale to the size of the microsoft graph apis.

A

So, with all these challenges in mind and with the learning that we got with autorest, we went back and we went back to work and we we focused and we decided to create a new sdks generator with the goal. We wanted something fast to support new languages.

A

We wanted to support new languages within weeks, not waiting for months for that to happen, and we wanted it to be very fast to incorporate new microsoft uh graph features across all our languages, like we really needed to keep up with all the new features that we have and we wanted something that is fast to generate an sdk.

A

So that's what we've been working on and and today I'm happy to announce that this new sdks generator already exists. It is in community preview, please go and try it and remember it's still a preview, so I'm sure there will be a few bumps and things that are not perfect yet, but your feedback is very important to us to make this better and to fix all the things. um As I mentioned, kyota is a new sdks generator.

A

It's a lightweight low maintenance, open api based code generator for our sdks, and it solves the problems that we set to solve. It is fast enough for us to generate our sdks um on top of solving these problems. These challenges for us kyoto also opens up a whole set of new opportunities and scenarios, because it's based on any open api or csgl described api literally, you could use it with anything. We do already. Actually some of the mvps um went ahead and played with kyota with different apis.

A

It wasn't even the microsoft graph apis and then they had a bunch of issues for us to fix you. You don't do this and you can do this. So um so that's that's quite nice to see the other thing is with kyota literally, you can create customized and tailored sdks to your exact needs, because all you need is the apis that you need in your project, so potentially the size of these sd card sdks is also going to be fairly smaller than the pre-packaged sdk. If that's what you need so please go and try it.

A

Kyota is a swahili word by the way for anyone, who's curious and it means a nest and to prove to you that it's all really real and it all works. uh I'm gonna do a demo um for this demo, so the end goal of the demo is to generate a.net sdk based on kyoto. For that I'm gonna need to do a few steps and go through our tooling I'm gonna.

A

The first stop is going to be graphics, plural, and I hope you are familiar with the graph explorer graph explorer- is our developer tool that allows you to learn and test with the graph apis, among other things, that you can do there so with graph explorer.

A

I would like to export a postman collection, so I'll go to graph explorer, get a postman collection for the end points that I need for my demo and then I am going to use another one of our tools. It's called hidey and heat is a command line tool that allows processing of open api documents. So things like transformations on open api documents. Let's say you need to go from v3 to v2, or vice versa, yaml to json or, and vice versa.

A

It also allows allows to validate your open api documents as well, so I'm going to use hidi and I'm going to use the postman collection that I will get from graph explorer and then that's how I'm gonna get my open api document. With that open api document, I can ask kyota to generate an sdk. For me this is the first stop graphic explorer very recently. I think two days ago we released a new feature with the graph explorer.

A

It's called resource explorer. It's this tab here resources and, as the name implies with resource explorer, you can explore and navigate every single resource and end point available on graph. As you can see on this tree here, you can see everything it is what's available on v1 by default. But if you need to check what's on beta, you can also do that and then that's what would allow me to export a postman collection, so the resources that I need for my demo are endpoints related to users.

A

So I'm gonna use the search and say look for users, and then I'm gonna see everything and anything that has users in it. But I am going all the way here. So I go to users and I can see I need this get so I'm gonna click on here and it says, add to collection and then, let's add post, for example.

A

So this is all I need, so my collection is fairly small. As you can see here, I have the two items that I added: I'm not gonna, remove anything and I'm just gonna say: please download this collection for me.

A

So, as you can see here, my collection has been downloaded to my machine and then, if I grab my command line tool now, as you can see, the name of the collection is too long. So uh previously I renamed the collection to something much easier and I put it in the right uh folder for me to er to work with it. So that's the first step done.

A

We do have now a postman collection now what I need from hidy, because we do have the graph uh open api document, but that document is too big for my needs. All I need is literally just the users, so I'm gonna ask kd to transform that document for me or, as we say, slice the document for me. So I'm going to say he d.

A

Can you transform this open api document, which is hopefully this one, and I want you to transform it filtering, so we're going to do some sort of filtering using that postman collection, which is users, collection, dot, json.

A

So I'm saying I don't need everything in there. Can you please do filter based on the collection and give me a much smaller document and then for my output? Let's say users output and if I do this, hopefully this should work anytime. Now, yes, so and go here, and I can see that was created and you can even see the time it literally just happened.

A

Now, I'm gonna do another thing, just to make sure that that document is okay, so I'm gonna say edie validate my document is users output, dot, yaml and then hidey is telling me. Yes, you have one like the path to the items. It's users, two operations get and post and everything else that is available there. We can even go if I click on the document, it will open and I can see that it is indeed an open api document. So that is the step number two.

A

So that's heidi who provided me with a much smaller, open api document so now I can go and generate the sdk that I need. Prior to the session, I created the console app.

A

That's where I will be using my sdk, so I did create the the app added all the packages that I need, etc on there and now.

A

So, if I go, let me just go to the right, so this is where my app is- and I'm gonna put this in here, so you can see it. So what I'm gonna say is kyoto.

A

And I'm gonna feed kyota. I also put the uh the document in the right folder, so I'm gonna feed kyota the exact same document, which is users, output, right, user's, output.yaml, and then I want my class to be user.

A

Api client.

A

Oh, I did. I did forget to mention that the app that I created is user. Client, that's why there is user client in there and then I'm gonna say uh my namespace is user, client and then api client.

A

Now, if I hit, if I hit enter, it should add my new sdk to my application, but because I did that earlier, I'm intrigued what would happen if I click twice whether it will figure out it's already there or it would just replace it, because I do that, I'm not going to risk it. So this is like how I would generate that if I go to my app here so this is my app.

A

I needed, of course, like a client, id, etc a few scaffolding things. So I did all of that and let's say I want to see my users. You will notice that here within my client.

A

The only thing that I have is users, so I don't have everything on the graph api. It's because the sdk that I created only have users, so I can say just. I only need my users here, for example, um and basically that that's really it that's. What I wanted to show you, I'm still I'm gonna click on this and see what happens.

A

Oh, maybe just replace it without doing anything, and you can see how how quick it is so yeah. So this is the demo. This is the few uh new things that we have. uh I have few uh links in here for you to try. Please go and try kyota, it's still in preview, so I'm sure there are some few things for us to fix it. Would um we would really appreciate it if you can help us point out to those things uh to fix. um Thank you.

B

Awesome robert really really really cool stuff, and it is absolutely brilliant that we can kind of increase the performance by reducing the api surface, which is which is automatically generated because just for reminder for everybody again on this call, there are tens of thousands of apis in microsoft. Graph which is like it should be. Everything should be accessed through the microsoft graph and it's brilliant, simple and unified way of accessing information in microsoft. 365.