.Net Foundation Code Conversations, 15 Aug 2017

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Website Resource Implementation in IIS Administration API with Jimmy Campbell

Description

Jimmy Campbell digs into the resources exposed by the IIS Administration API, then shows how they implemented the website resource.
Source code for this presentation: https://github.com/microsoft/iis_administration

A

Hi and welcome to code conversations. today we're talking to jimmy campbell.

A

B

Today I want to talk about the iis administration api and for this code.

B

Conversation, I thought a good topic would be one of the most important.

B

Resources of iis and that's the website, okay, and so I want to talk about how we.

B

Implemented the website resource a nice administration api and that can kind of.

B

Give an idea of what it means to implement any resource in our code base.

B

Awesome. all right, so this is the api explorer that I brought up in our last.

B

Code conversation this allows you to browse the api endpoints of the iis.

B

Administration api exposes so this is that rest, api endpoint, you described.

A

Last time- and this allows you to go through and configure and set up and do.

A

All kinds of things with I it exactly allows you to configure, is monitor.

B

Health setups http endpoints on your websites, the works and this. This cool.

B

Right here allows you to see exactly how the api is exposing itself. As you see.

B

Right here the webserver endpoint has websites. We expect. I asked to have some.

B

Websites set up for serving any content, so I just want to show what a website.

B

Resource looks like, and this is it right here so if you're consuming this api.

B

This is going to be the response you get whenever you're querying website.

B

Resource., so this is this tool is really good for maybe prototyping, like your.

B

Very first time using it, you can see exactly what you're working with here you can see. I have binding set up for http binding, my name and all these.

B

Properties that I need to administer my website so now we can jump into the code.

B

And I can show you all how this is done.

B

So this is the code base for the iis.

B

Administration, api and right now, I'm in the web sites plugin.

B

So the first thing that happens for every plugin- well, every resource in iis, is first of all.

B

Implemented as a plug-in in this code, base. now on the start of the application, these plugins are loaded and we talked about in our last code conversation so.

B

An important thing to talk about in the websites plug-in is what's happening.

B

When it's so it's overall, it's pretty simple! You.

B

Can see the website plug-in is just registering one controller. The site's.

B

Controller and it's listening to the websites path or it's processing.

B

Requests on websites path. okay., so that was what we said: plugins were capable doing, having their own controls registered and then they can they're on.

B

Their own at that point, so we have the site controller, exposing the website.

B

Resource so let's go into that now.! This is a standard. This is a controller.

B

Yeah, this is something..., I'm used to this. yeah, exactly., so we have our plugins. They pretty much have one or two controllers and they're in charge of serializing. The.

B

Resource and knowing how to manipulate the resource, so it's really isolated.

B

That's kind of architecture we went with and we make sure that whenever it comes.

B

To manipulating a resource, we do it in a rest manner and we isolate all.

B

Manipulation of resources to one controller, so it's one entry point into.

B

The code., okay. and- and we want to be able to support things like create, read, update, delete and we do that in the rest way. By having.

B

Get for reading posts for creating patch for updating, so we use patch and delete.

B

Of course, the deleting so, as you can see, this is where any operation with the.

B

Website and the eye administration api is going to take place so, for example, we.

B

Can talk about what it what's happening whenever retrieve the the websites.

B

Devise ministration api, so we come in to our sites controller. That's registered.

B

By the plug-in, the first thing we're doing is we're checking for any.

B

Filtering are you looking at all the sites for an application pool? That's.

B

Something we support, or are you just trying to get all the sites, so we take.

B

That new account we get all the slides together. Then we just set some helping.

B

Some additive information to the response, such as how many items are in.

B

The response so we're setting some headers and then we support the ability.

B

To select the fields that the resource shows in the response., oh. okay., so actually.

B

Let me show that right, here.

B

If I say fields equals name,, it only returns the name... yeah and if I do fields equals star.

B

It'll return everything, so that's what's happening right here: okay and then.

B

Finally, we return the website, so ultimately we we keep our controllers.

B

Pretty nice and clean, so we want to be able to isolate exactly where the code.

B

Is entering and we don't want to overcomplicate it right at the start, so.

B

Every plugin has the controller, and then one other thing I want to touch on is.

B

Exactly the model we use for taking this c# class, this resource that we use.

B

In code and making it something that adheres to a json response, it's.

B

Something a json object would look like. Okay, so you'll see all of our plugins.

B

Use this to json model and whenever we turn something every resource will have.

B

A helper method like this., and what we do here is if I go to actually I'll just go.

B

Straight to it to json model.

B

All right,, so we have a site, resource and or a site.

B

Object in our code now we want to turn that into something an anonymous object.

B

Is what we use that we can transfer over the wire and it's useful when you're.

B

Consuming a rest, api. okay., so in all of our plugins we have the same model. We we always see your life swing to json model. That's what we're going to put on the wire and with so we take some resource, the fields that we want to expose. We add.

B

To those fields- and we use notation this snake case, I believe- is the lowercase.

B

Here so we're basically saying like a site's physical path is now going to be this.

B

Thing right here and that's a model that we use so the this controller entry.

B

Point and then the to json model exit point is the basis of all of our plugins.

B

So they're, starting up exposing some endpoints, goes in the controller.

B

Whatever processing does ultimately comes in to some json model and exits.

B

Okay. mvc is going to serialize that for us using the json libraries that it uses.

B

But that's the architecture that we're using so cool, ok, yeah! So that's pretty.

B

Much all I wanted to touch on. Basically the use standard things that all of our plugins are doing for today and one last.

B

Thing I want to bring up is just a reminder that this is open source, so you.

B

Can go to github..., you can go to github... in our if it comes up...

B

This is wait for it to load, wait for it all right yeah. So this is administration.

B

Api is completely open-source. The code is available here, so, if you ever want to.

B

Contribute or make some suggestions the way we're developing things feel free to.

B

Go ahead and do that.

A

Awesome!: okay, thanks a bunch, jimmy! cool. thank you.